mozilla-services / mozilla-services/markus
sphinx extension for documenting keys used
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 70
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Markus should have a sphinx extension that makes it easier to document the keys in use, link to them in the docs, and spit out a listing of all the documented keys.
Maybe something like this:
.. markus:metric:: widget.count
:type: count
This key counts the number of widgets made.
... markus:metricslist::
:markus:metric:`widget.count`
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 requested Sphinx directives and role shown in the issue, then inspect the Markus documentation and Sphinx configuration to locate the appropriate extension entry point. Done means documenting keys, linking to them from the docs, and producing a listing of all documented keys as described.
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
- Mostly clear
- Newbie friendliness
- 35/100