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

Conversation

peterhessey
Copy link
Contributor

Closes #759

Moving all existing documentation onto RTD so that it is all in one consistent place. Also fixes problems with RTD not displaying all markdown documentation correctly.

@peterhessey peterhessey changed the title 📝Move docs folder to sphinx-docs ENH: Move docs folder to sphinx-docs Jul 21, 2022
@peterhessey peterhessey force-pushed the phessey/move-docs-to-RTD branch 3 times, most recently from cf03a49 to 6abc048 Compare July 21, 2022 14:42
@fepegar
Copy link
Contributor

fepegar commented Jul 21, 2022

I suggest renaming sphinx-docs to docs, as is common practice.

sphinx-docs/preprocess.py Outdated Show resolved Hide resolved
@peterhessey peterhessey force-pushed the phessey/move-docs-to-RTD branch 11 times, most recently from 710b920 to 868c82b Compare July 26, 2022 14:34
@peterhessey
Copy link
Contributor Author

For some reason the images are not currently rendering properly and I can't figure out why:

image

Going to open a separate issue for this and investigate later - this PR is already becoming oversized and it's not a major issue as it only affects two images, one of which is in the README anyway.

Marking this PR as ready for review (many other issues to be opened shortly, RTD is far from finished!)

@peterhessey peterhessey marked this pull request as ready for review July 26, 2022 14:36
Copy link
Contributor

@ant0nsc ant0nsc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good apart from one niggle - IDE settings should not be gitignored.

.gitignore Outdated Show resolved Hide resolved
sphinx-docs/README.md Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/WSL.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/bring_your_own_model.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/bring_your_own_model.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/building_models.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/deploy_on_aml.md Outdated Show resolved Hide resolved
sphinx-docs/source/docs/innereye_deeplearning.md Outdated Show resolved Hide resolved
@peterhessey peterhessey marked this pull request as draft August 2, 2022 12:39
@peterhessey peterhessey marked this pull request as ready for review August 3, 2022 14:35
docs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fepegar fepegar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image in https://innereye-deeplearning--768.org.readthedocs.build/md/deploy_on_aml.html is still not showing up. Is that expected?

@peterhessey
Copy link
Contributor Author

The image in https://innereye-deeplearning--768.org.readthedocs.build/md/deploy_on_aml.html is still not showing up. Is that expected?

not expected but I haven't figured out the fix yet, opening a new issue to focus on that next. It builds and displays just fine locally, and doesn't 404 when you navigate to the URL of the image. It just doesn't seem to be uploading the source images correctly for some reason.

@peterhessey peterhessey merged commit c1b363e into main Aug 4, 2022
@peterhessey peterhessey deleted the phessey/move-docs-to-RTD branch August 4, 2022 08:15
This was referenced Aug 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move documentation to Read The Docs
4 participants