move documentation off readthedocs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1k
- Forks
- 412
- Avg merge
- 6d 10h
- Merged PRs (30d)
- 3
Description
readthedocs shows ads on our docs now. we already have cms-dev.github.io, we could serve docs from there.
note for generating docs ourselves: dev-dependencies.txt pins an ancient version of sphinx. readthedocs actually completely ignores this and builds with latest sphinx (and our docs use a sphinx 8.x feature in at least one place). we can't just bump our declared sphinx dependency because that'll pull in a newer version of jinja (which is pinned to 2.x because of the tornado problem). so for now i think we should just remove sphinx from our dev-dependencies and install the right version in some separate build script.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the existing documentation configuration and dev-dependencies.txt, then compare how ReadTheDocs builds the docs versus the proposed cms-dev.github.io setup. Define a separate build script that installs a compatible Sphinx version without changing the pinned Jinja/Tornado dependency relationship, and verify that the generated documentation is served from the new location without ReadTheDocs ads.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100