Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

ENH: Move docs folder to sphinx-docs #768

Merged
merged 26 commits into from
Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3f49383
📝Move docs folder to sphinx-docs
peterhessey Jul 21, 2022
8f8513d
Trigger build for new URL
peterhessey Jul 21, 2022
3390a4a
📝 Fix build to include README + CHANGLOG
peterhessey Jul 22, 2022
6487d06
📝 Add back in link fixing
peterhessey Jul 22, 2022
da3f4de
🐛 Fix docs links
peterhessey Jul 22, 2022
a319eac
🚨 📝 Fix markdown linting
peterhessey Jul 22, 2022
2591db6
📝 Change relative links to GitHub ones permanently
peterhessey Jul 22, 2022
3d201e2
📝 Replace more relative paths
peterhessey Jul 22, 2022
9fc25a9
⚡️ 📝 Switch to symlinks
peterhessey Jul 25, 2022
e8c6852
📝 Replace README in toctree
peterhessey Jul 25, 2022
e2702b5
📝 Update README
peterhessey Jul 26, 2022
46c1966
🐛 Attempt to fix images not rendering
peterhessey Jul 26, 2022
7f2c2e6
🐛 Fix broken links
peterhessey Jul 26, 2022
8156e79
Remove IDE settings from gitignore
peterhessey Jul 27, 2022
678b616
⚡️ Move docs to `docs/` and add Makefile back
peterhessey Jul 27, 2022
33e3a06
🙈 Update gitignore
peterhessey Jul 27, 2022
27e2893
♻️ ⚡️ Resolve review comments and change theme
peterhessey Jul 28, 2022
07ee50e
📝 🔀 Rebase + markdown linting
peterhessey Aug 2, 2022
686ca06
🔥 Remove build files (again)
peterhessey Aug 2, 2022
cc54f15
🙈 Remove pieline-breaking symlink
peterhessey Aug 2, 2022
11ecd1f
➕ Add furo to sphinx dependencies
peterhessey Aug 2, 2022
5353ae3
📌 Move sphinx deps to environment.yml + lock
peterhessey Aug 3, 2022
f5d3f76
📝 Improve doc folder structure
peterhessey Aug 3, 2022
a30f609
Return to copying instead of symlink
peterhessey Aug 3, 2022
5985fda
📝 Update indexing and titles
peterhessey Aug 3, 2022
efc5f9e
📝 Address review comments
peterhessey Aug 3, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
🔥 Remove build files (again)
  • Loading branch information
peterhessey committed Aug 2, 2022
commit 686ca06eaa37d37bac4494bda9f50fc19254294a
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ InnerEye-DeepLearning (IE-DL) is a toolbox for easily training deep learning mod

- Segmentation models.
- Classification and regression models.
- Any PyTorch Lightning model, via a [bring-your-own-model setup](https://innereye-deeplearning.readthedocs.io/en/latest/docs/bring_your_own_model.html).
- Any PyTorch Lightning model, via a [bring-your-own-model setup](https://innereye-deeplearning.readthedocs.io/docs/bring_your_own_model.html).

In addition, this toolbox supports:

Expand All @@ -17,11 +17,11 @@ In addition, this toolbox supports:

## Documentation

For all documentation, including setup guides and APIs, please refer to the [IE-DL Read the Docs site](https://innereye-deeplearning.readthedocs.io/en/latest/#).
For all documentation, including setup guides and APIs, please refer to the [IE-DL Read the Docs site](https://innereye-deeplearning.readthedocs.io/#).

## Quick Setup

This quick setup assumes you are using a machine running Ubuntu with Git, Git LFS, Conda and Python 3.7+ installed. Please refer to the [setup guide](https://innereye-deeplearning.readthedocs.io/en/latest/docs/environment.html) for more detailed instructions on getting InnerEye set up with other operating systems and installing the above prerequisites.
This quick setup assumes you are using a machine running Ubuntu with Git, Git LFS, Conda and Python 3.7+ installed. Please refer to the [setup guide](https://innereye-deeplearning.readthedocs.io/docs/environment.html) for more detailed instructions on getting InnerEye set up with other operating systems and installing the above prerequisites.

1. Clone the InnerEye-DeepLearning repo by running the following command:

Expand Down
Binary file removed docs/build/doctrees/docs/CHANGELOG.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/InnerEye/README.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/WSL.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/docs/building_models.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/contributing.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/creating_dataset.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/docs/deploy_on_aml.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/environment.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/fastmri.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/hello_world_model.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/hippocampus_model.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/docs/model_diagnostics.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/move_model.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/pull_requests.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/releases.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/sample_tasks.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/docs/setting_up_aml.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/docs/testing.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/ML/augmentations.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/ML/configs.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/ML/index.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/ML/pipelines.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/ML/runner.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/rst/api/index.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/build/html/.buildinfo

This file was deleted.

3 changes: 0 additions & 3 deletions docs/build/html/_images/deployment.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/build/html/_images/screenshot_azureml_patch_sampling.png

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

935 changes: 0 additions & 935 deletions docs/build/html/_modules/InnerEye/ML/config.html

This file was deleted.

482 changes: 0 additions & 482 deletions docs/build/html/_modules/InnerEye/ML/photometric_normalization.html

This file was deleted.

219 changes: 0 additions & 219 deletions docs/build/html/_modules/InnerEye/ML/pipelines/ensemble.html

This file was deleted.

462 changes: 0 additions & 462 deletions docs/build/html/_modules/InnerEye/ML/pipelines/inference.html

This file was deleted.

314 changes: 0 additions & 314 deletions docs/build/html/_modules/InnerEye/ML/pipelines/scalar_inference.html

This file was deleted.

585 changes: 0 additions & 585 deletions docs/build/html/_modules/InnerEye/ML/runner.html

This file was deleted.

276 changes: 0 additions & 276 deletions docs/build/html/_modules/index.html

This file was deleted.

Loading