python-trio / python-trio/trio
Teach sphinx about the difference between object public names and private names, to enable source links, etc.?
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
This is an example from the same documentation engine in Tornado.
It may be useful.
Personally, helped me a lot with other projects.
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
No Trio files, tests, or entry points are named. Start by reviewing the linked Tornado documentation example and Trio’s current documentation output, then define the intended public/private-name and source-link behavior; done requires agreed behavior and corresponding documentation changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100