Generate python documentation without requiring compilation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 3
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 7
Description
We can't easily build these modules on readthedocs -- and honestly, we probably don't want to anyways. Instead, if we had an rst generator template, then readthedocs could just run that and then we'd have docs.
This seems easier than trying to get sphinx to read from pyi files -- and the pyi files would have references to other non-installed modules (which aren't really required to create documentation), so the imports would fail.
Maybe @auscompgeek has a better idea?
Contributor guide
No contributing guide indexed for this repository
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 locating the Read the Docs configuration and any existing Sphinx or RST-generation entry points. Review how the pyi files and non-installed module imports are currently handled, then define a documentation-only path whose completion can be verified by building the docs without compiling the wrapped modules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100