⚡️ Move docs to docs/ and add Makefile back

microsoft · Jul 27, 2022 · d35b503 · d35b503
1 parent ae27992
commit d35b503
Show file tree

Hide file tree

Showing 41 changed files with 70 additions and 12 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,11 +9,11 @@ build:
  python: miniconda3-4.7
 
 sphinx:
- configuration: sphinx-docs/source/conf.py
+ configuration: docs/source/conf.py
 
 python:
  install:
- - requirements: sphinx-docs/requirements.txt
+ - requirements: docs/requirements.txt
 
 conda:
  environment: environment.yml
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,12 @@
+# Building docs for InnerEye-DeepLearning
+
+1. First, make sure you have all the packages necessary for InnerEye.
+1. Install pip dependencies from sphinx-docs/requirements.txt:
+
+```shell
+pip install -r requirements.txt
+```
+
+1. Run `make html` from the `docs` folder. This will create html files under docs/build/html.
+1. From the `docs/build/html` folder, run `python -m http.server 8080` to host the docs locally.
+1. From your browser, navigate to `http:https://localhost:8080` to view the documentation.
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/sphinx-docs/requirements.txt → docs/requirements.txt b/sphinx-docs/requirements.txt → docs/requirements.txt
diff --git a/sphinx-docs/source/conf.py → docs/source/conf.py b/sphinx-docs/source/conf.py → docs/source/conf.py
diff --git a/docs/source/docs/CHANGELOG.md b/docs/source/docs/CHANGELOG.md
@@ -0,0 +1 @@
+/home/phessey/Repos/InnerEye-DeepLearning/CHANGELOG.md
diff --git a/sphinx-docs/source/docs/WSL.md → docs/source/docs/WSL.md b/sphinx-docs/source/docs/WSL.md → docs/source/docs/WSL.md
diff --git a/...-docs/source/docs/bring_your_own_model.md → docs/source/docs/bring_your_own_model.md b/...-docs/source/docs/bring_your_own_model.md → docs/source/docs/bring_your_own_model.md
diff --git a/sphinx-docs/source/docs/building_models.md → docs/source/docs/building_models.md b/sphinx-docs/source/docs/building_models.md → docs/source/docs/building_models.md
diff --git a/sphinx-docs/source/docs/contributing.md → docs/source/docs/contributing.md b/sphinx-docs/source/docs/contributing.md → docs/source/docs/contributing.md
diff --git a/sphinx-docs/source/docs/creating_dataset.md → docs/source/docs/creating_dataset.md b/sphinx-docs/source/docs/creating_dataset.md → docs/source/docs/creating_dataset.md
diff --git a/...s/source/docs/debugging_and_monitoring.md → docs/source/docs/debugging_and_monitoring.md b/...s/source/docs/debugging_and_monitoring.md → docs/source/docs/debugging_and_monitoring.md
diff --git a/sphinx-docs/source/docs/deploy_on_aml.md → docs/source/docs/deploy_on_aml.md b/sphinx-docs/source/docs/deploy_on_aml.md → docs/source/docs/deploy_on_aml.md
diff --git a/sphinx-docs/source/docs/environment.md → docs/source/docs/environment.md b/sphinx-docs/source/docs/environment.md → docs/source/docs/environment.md
diff --git a/sphinx-docs/source/docs/fastmri.md → docs/source/docs/fastmri.md b/sphinx-docs/source/docs/fastmri.md → docs/source/docs/fastmri.md
diff --git a/sphinx-docs/source/docs/hello_world_model.md → docs/source/docs/hello_world_model.md b/sphinx-docs/source/docs/hello_world_model.md → docs/source/docs/hello_world_model.md
diff --git a/docs/hippocampus_model.md → docs/source/docs/hippocampus_model.md b/docs/hippocampus_model.md → docs/source/docs/hippocampus_model.md
diff --git a/...nx-docs/source/docs/images/deployment.png → docs/source/docs/images/deployment.png b/...nx-docs/source/docs/images/deployment.png → docs/source/docs/images/deployment.png
diff --git a/docs/hippocampus_metrics_boxplot.png → ...cs/images/hippocampus_metrics_boxplot.png b/docs/hippocampus_metrics_boxplot.png → ...cs/images/hippocampus_metrics_boxplot.png
diff --git a/...ce/docs/images/patch_sampling_example.png → ...ce/docs/images/patch_sampling_example.png b/...ce/docs/images/patch_sampling_example.png → ...ce/docs/images/patch_sampling_example.png
diff --git a/...ges/screenshot_azureml_patch_sampling.png → ...ges/screenshot_azureml_patch_sampling.png b/...ges/screenshot_azureml_patch_sampling.png → ...ges/screenshot_azureml_patch_sampling.png
diff --git a/...docs/source/docs/innereye_as_submodule.md → docs/source/docs/innereye_as_submodule.md b/...docs/source/docs/innereye_as_submodule.md → docs/source/docs/innereye_as_submodule.md
diff --git a/...docs/source/docs/innereye_deeplearning.md → docs/source/docs/innereye_deeplearning.md b/...docs/source/docs/innereye_deeplearning.md → docs/source/docs/innereye_deeplearning.md
diff --git a/sphinx-docs/source/docs/model_diagnostics.md → docs/source/docs/model_diagnostics.md b/sphinx-docs/source/docs/model_diagnostics.md → docs/source/docs/model_diagnostics.md
diff --git a/sphinx-docs/source/docs/move_model.md → docs/source/docs/move_model.md b/sphinx-docs/source/docs/move_model.md → docs/source/docs/move_model.md
diff --git a/sphinx-docs/source/docs/pull_requests.md → docs/source/docs/pull_requests.md b/sphinx-docs/source/docs/pull_requests.md → docs/source/docs/pull_requests.md
diff --git a/sphinx-docs/source/docs/releases.md → docs/source/docs/releases.md b/sphinx-docs/source/docs/releases.md → docs/source/docs/releases.md
diff --git a/sphinx-docs/source/docs/sample_tasks.md → docs/source/docs/sample_tasks.md b/sphinx-docs/source/docs/sample_tasks.md → docs/source/docs/sample_tasks.md
diff --git a/...ocs/source/docs/self_supervised_models.md → docs/source/docs/self_supervised_models.md b/...ocs/source/docs/self_supervised_models.md → docs/source/docs/self_supervised_models.md
diff --git a/sphinx-docs/source/docs/setting_up_aml.md → docs/source/docs/setting_up_aml.md b/sphinx-docs/source/docs/setting_up_aml.md → docs/source/docs/setting_up_aml.md
diff --git a/sphinx-docs/source/docs/testing.md → docs/source/docs/testing.md b/sphinx-docs/source/docs/testing.md → docs/source/docs/testing.md
diff --git a/sphinx-docs/source/index.rst → docs/source/index.rst b/sphinx-docs/source/index.rst → docs/source/index.rst
diff --git a/...-docs/source/rst/api/ML/augmentations.rst → docs/source/rst/api/ML/augmentations.rst b/...-docs/source/rst/api/ML/augmentations.rst → docs/source/rst/api/ML/augmentations.rst
diff --git a/sphinx-docs/source/rst/api/ML/configs.rst → docs/source/rst/api/ML/configs.rst b/sphinx-docs/source/rst/api/ML/configs.rst → docs/source/rst/api/ML/configs.rst
diff --git a/sphinx-docs/source/rst/api/ML/index.rst → docs/source/rst/api/ML/index.rst b/sphinx-docs/source/rst/api/ML/index.rst → docs/source/rst/api/ML/index.rst
diff --git a/.../rst/api/ML/photometric_normalization.rst → .../rst/api/ML/photometric_normalization.rst b/.../rst/api/ML/photometric_normalization.rst → .../rst/api/ML/photometric_normalization.rst
diff --git a/sphinx-docs/source/rst/api/ML/pipelines.rst → docs/source/rst/api/ML/pipelines.rst b/sphinx-docs/source/rst/api/ML/pipelines.rst → docs/source/rst/api/ML/pipelines.rst
diff --git a/sphinx-docs/source/rst/api/ML/runner.rst → docs/source/rst/api/ML/runner.rst b/sphinx-docs/source/rst/api/ML/runner.rst → docs/source/rst/api/ML/runner.rst
diff --git a/sphinx-docs/source/rst/api/index.rst → docs/source/rst/api/index.rst b/sphinx-docs/source/rst/api/index.rst → docs/source/rst/api/index.rst
diff --git a/sphinx-docs/README.md b/sphinx-docs/README.md