widgetti / widgetti/ipyvuetify
Add API documentation for downstream intersphinx
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 61
- PR merge metrics
- No merged PRs in 30d
Description
Motivation: To be able to use Sphinx's intersphinx feature to link to your API documentation, such as ipyvuetify.VuetifyTemplate.VuetifyTemplate.
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 how Sphinx intersphinx consumes API documentation and how the ipyvuetify.VuetifyTemplate.VuetifyTemplate API is currently exposed. Done means downstream projects can link to that API through intersphinx; the issue names no files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100