feanil/fix docs build #36259
Merged
feanil/fix docs build #36259
Conversation
This file contains hidden or 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
Contributor
feanil
commented
Feb 14, 2025
feanil
commented
- build: Add more apps to the set of installed apps.
- build: We don't need to override this setting.
- docs: Update the Open API docs.
These app models get pulled in when trying to build the OpenAPI docs so we need their relevant apps installed into the environment used to generate the docs.
bmtcril
reviewed
Feb 14, 2025
docs/conf.py
Outdated
| @@ -112,7 +112,7 @@ | |||
| # You can specify multiple suffix as a list of string: | |||
| # | |||
| # source_suffix = ['.rst', '.md'] | |||
| source_suffix = '.rst' | |||
| # source_suffix = '.rst' | |||
There was a problem hiding this comment.
Should this just get deleted?
|
Are the Open API docs generated somehow or are these manual edits? |
The format of the `source_suffix` setting has change but the default is fine for us so we don't need to override this.
feanil
force-pushed
the
feanil/fix_docs_build
branch
from
f6572bd to
b079d4c
Compare
|
The API docs are generated as a part of running the |
bmtcril
approved these changes
Feb 18, 2025
|
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. |
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.