Add repository rst files in the sphinx docs #34462
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
farhan
force-pushed
the
farhan/add-rst-files-in-docs-2
branch
from
45f044f to
508eedc
Compare
This was referenced Apr 3, 2024
farhan
force-pushed
the
farhan/add-rst-files-in-docs-2
branch
from
508eedc to
6a196b4
Compare
irtazaakram
requested changes
Apr 25, 2024
farhan
force-pushed
the
farhan/add-rst-files-in-docs-2
branch
from
6a196b4 to
6c4170b
Compare
irtazaakram
approved these changes
Apr 29, 2024
feanil
approved these changes
Apr 30, 2024
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
|
2U Release Notice: This PR has been deployed to the edX production environment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket: #33950
Planning ticket: #33047
Details of Implementation:
repository_docs.py contains the code to:
docsdirectory to make them linkable in thesphinxbuild process.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
docsdirectoryas discussed here
#33997
#34405
Testing instructions
lms-shellgo to/edx-platform/docsmake htmlcommand to generate docsdocsdirectory for the files generated in the build processdocs/_build/html/index.htmlin browser to navigate the docsedx-platform/docs/_build/html/references/docs/index.html