libgit2 / libgit2/pygit2

RTD autoupdate?

Open
#997 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
408
Avg merge
2d 57m
Merged PRs (30d)
7

Description

Hi, I noticed that there's been some updates to the backend page in docs but the website page https://www.pygit2.org/backends.html seems to have been last updated in winter.

Where are the docs hosted? If it's RTD, they support autopublishing on new commits.

If not RTD, why? Is it updated manually then? Any reason not to use RTD?

Contributor guide

Open the contributing guide

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.

Research direction

Start by comparing the backend page in the linked PR with the published page at pygit2.org/backends.html, then identify where the project documentation is hosted. Determine whether Read the Docs autopublishing is enabled or why updates are manual; done means the hosting and update process are clarified and the stale page is addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.