pytest-dev / pytest-dev/pytest-html
Investigate if we need to add a linter for Read the Docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 779
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
Read the docs may or may not perform sufficient linting for us. The purpose of this card is to investigate our linting options and add a linter if needed
I did some research and found that we can still use rst-lint, but we need to allow the following two directives:
automoduletoctree
The above can be done via https://github.com/twolfson/restructuredtext-lint#sphinx. I'll try to make a PR for this in the next few days. It will involve a custom script for the docs
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 issue's proposed use of rst-lint and its Sphinx support for the automodule and toctree directives. Investigate the repository's documentation workflow and determine whether a custom docs script is needed; done means adding the linter only if required and allowing those directives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100