edx-platform
edx-platform copied to clipboard
Add repository rst files in the sphinx docs
Ticket: https://github.com/openedx/edx-platform/issues/33950 Planning ticket: https://github.com/openedx/edx-platform/issues/33047
Details of Implementation:
repository_docs.py contains the code to:
- Fetch the list of all the .rst docs/files in the repository
- Copy all these .rst files into
docsdirectory to make them linkable in thesphinxbuild process. - Generate the index.rst files in the new created directories to link all the copied .rst files in the sphinx docs.
I have closed following PR's and terminated these previous implementations associated with this feature as these approaches have technical limitations to proceed. For example to refer the .rst files outside of root docs directory
as discussed here
https://github.com/openedx/edx-platform/pull/33997
https://github.com/openedx/edx-platform/pull/34405
Testing instructions
- Checkout the branch
- In
lms-shellgo to/edx-platform/docs - Run
make htmlcommand to generate docs - Explore
docsdirectory for the files generated in the build process - Open
docs/_build/html/index.htmlin browser to navigate the docs - Docs will be listed on path
edx-platform/docs/_build/html/references/docs/index.html
| Screenshots |
|---|