pymc-devs / pymc-devs/pymc-examples
Add (or automate a bit more) object index generation
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 398
- Forks
- 325
- Avg merge
- 9d 15m
- Merged PRs (30d)
- 1
Description
It doesn't make much sense to work on this until https://github.com/pymc-devs/pymc/issues/5282 is resolved. After that, given the objects are listed in the versioned docs and there is already a template on how to do is introduced by #276 it can be labeled as good first issue.
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
Wait for pymc-devs/pymc#5282 to be resolved first. Then inspect how objects are listed in the versioned docs and review the object-index template introduced by #276. Done means the object index generation is automated further using that existing documentation structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100