readthedocs / readthedocs/sphinx-autoapi
Add a template for testing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
It would be super nice if there was a template somewhere that I could copy/paste and modify to generate simple, small, self-contained examples of code that I suspect illustrates issues/bugs with sphinx-autoapi. At the moment I think one would have to manually go through sphinx-quickstart then also create a python project and add autoapi to it.
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 reviewing the existing sphinx-quickstart workflow and the Python project setup described in the issue. Add a reusable template for small, self-contained sphinx-autoapi examples that avoids repeating those manual steps, and verify that it can be copied, modified, and used to reproduce suspected bugs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, testing
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100