Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update to allow RTD to build these Docs #32752

Merged
merged 4 commits into from
Jul 17, 2023
Merged

Update to allow RTD to build these Docs #32752

merged 4 commits into from
Jul 17, 2023

Conversation

feanil
Copy link
Contributor

@feanil feanil commented Jul 14, 2023

  • build: Add base requirements to docs.
  • chore: Run make upgrade
  • build: Install edx-platform as a part of the docs setup.
  • docs: Don't build certain doc strings for now.

@feanil feanil changed the title feanil/rtd test branch Update to allow RTD to build these Docs Jul 14, 2023
@feanil feanil requested review from kdmccormick and a team July 14, 2023 21:29
@feanil feanil force-pushed the feanil/rtd_test_branch branch 3 times, most recently from 21aa365 to 7dc7161 Compare July 17, 2023 14:37
feanil added 2 commits July 17, 2023 10:49
@feanil
build: Add base requirements to docs.
3762119 
If we want to build autodocs from the code, we need the dependencies of
the code installed as a part of the docs build.
@feanil
build: Install edx-platform as a part of the docs setup.
a443360
@feanil feanil force-pushed the feanil/rtd_test_branch branch from 7dc7161 to 08cb248 Compare July 17, 2023 16:39
@feanil feanil requested a review from a team July 17, 2023 17:15
ormsbee
ormsbee approved these changes Jul 17, 2023
View reviewed changes
Copy link
Contributor

@ormsbee ormsbee left a comment

Choose a reason for hiding this comment

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

Approved, but one nit where I think a comment might be helpful in case you have to walk away from this for a while.

docs/guides/conf.py
'xmodule': 'references/docstrings/xmodule',
# 'cms': 'references/docstrings/cms',
# 'common': 'references/docstrings/common',
# 'xmodule': 'references/docstrings/xmodule',
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Maybe a line explaining why these are commented out?

feanil added 2 commits July 17, 2023 14:01
@feanil
docs: Don't build certain doc strings for now.
90c4155 
We ran into memory issues at RTD so skip the xmodule, cms and common
docs for now so we can get some of the stuff up.  We can come back to it
later once we make things better.
@feanil
chore: Run make upgrade
1de6ff7
@feanil feanil force-pushed the feanil/rtd_test_branch branch from 08cb248 to 1de6ff7 Compare July 17, 2023 18:01
@feanil feanil merged commit 238db45 into master Jul 17, 2023
@feanil feanil deleted the feanil/rtd_test_branch branch July 17, 2023 20:45
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

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
Reviewers

@e0d e0d e0d approved these changes

@ormsbee ormsbee ormsbee approved these changes

@kdmccormick kdmccormick Awaiting requested review from kdmccormick

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@feanil @edx-pipeline-bot @ormsbee @e0d