Skip to content

build: Adjust docs/conf.py to fix RTD build - #591

Merged
sarina merged 2 commits into
mainfrom
sarina/rtdconf-2
May 8, 2026
Merged

build: Adjust docs/conf.py to fix RTD build#591
sarina merged 2 commits into
mainfrom
sarina/rtdconf-2

Conversation

@sarina

@sarina sarina commented May 8, 2026

Copy link
Copy Markdown
Contributor

See https://daniel.feldroy.com/posts/2023-01-configuring-sphinx-auto-doc-with-django for two issues - path needed to be specified, and DJANGO_SETTINGS_MODULE needs to be set after the path is fixed.

THE DOC BUILD... IT LIVES

@sarina
sarina marked this pull request as draft May 8, 2026 04:34
@sarina
sarina force-pushed the sarina/rtdconf-2 branch from 378141a to 0a09282 Compare May 8, 2026 05:10
@sarina
sarina force-pushed the sarina/rtdconf-2 branch from b07afc5 to 82e3a84 Compare May 8, 2026 05:16
@sarina
sarina marked this pull request as ready for review May 8, 2026 05:20
@sarina

sarina commented May 8, 2026

Copy link
Copy Markdown
Contributor Author

@ormsbee the docs are absolutely now BUILDING on PRs: https://app.readthedocs.org/projects/openedx-core/builds/ but they are not reporting on them. I'll check with Feanil, I'm not sure what steps I may have missed.

I also dug in a bit to your question about headers. With napoleon - already installed on this repo - we could convert docstrings to Google Python or NumPy-style docstrings, with sections instead of :param ...:s. And a lot of header options are already built in. This won't necessarily solve all your header problems, but might be helpful.

@sarina
sarina force-pushed the sarina/rtdconf-2 branch from af89a71 to 82e3a84 Compare May 8, 2026 15:53
@sarina

sarina commented May 8, 2026

Copy link
Copy Markdown
Contributor Author

I didn't have to bother Feanil, I remembered what I did wrong (didn't give the readtheddocs bot WRITE access to the repo - https://github.com/orgs/openedx/teams/bot-readthedocs)

image

@ormsbee this is ready to merge

@sarina
sarina merged commit cf34836 into main May 8, 2026
12 checks passed
@sarina
sarina deleted the sarina/rtdconf-2 branch May 8, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants