crossbario / crossbario/autobahn-python
XBR API docs: some imports fail on RTD
Open
Nobody has claimed this yet.
bug
CI-CD
needs-investigation
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 768
- PR merge metrics
- No merged PRs in 30d
Description
https://autobahn.readthedocs.io/en/latest/reference/autobahn.html
It looks like sphinx-autodoc didn't run properly; only util has any documentation, all other sections are blank.
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 with the referenced Autobahn API documentation page and inspect how Sphinx autodoc is configured for its imports. Determine why only util is rendered, then verify that the other API sections are populated in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100