MarketSquare / MarketSquare/robotframework-sherlock
Automatically built documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 14
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
To be considered either reusing Robocop/Robotidy way of doing it (readthedocs) or hosting the docs using Github Pages / other option for generating html files (if not Sphinx).
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
Compare how Robocop and Robotidy reuse Read the Docs with the alternatives of GitHub Pages or another HTML-generation option, including Sphinx. Done means selecting and implementing an approach that automatically builds and hosts the project documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100