Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Automatically built documentation

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, python

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.

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).

Dominant language
Python
Stars
14
Forks
1
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MarketSquare/robotframework-sherlock

All issues in MarketSquare/robotframework-sherlock

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.