ni / ni/nimi-python

Create docs requirements files for reproducible docs builds

Open
#1,968 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build docs
Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Description

Description of issue

Our original nimi-python ReadTheDocs project used the dependencies listed here, by default.

Newer projects use the latest stuff, which is a moving target. Since we've decided to replace our original project with new independent projects, we should lock down our docs build deps, so that our rendered documentation doesn't suddenly change on us.

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 with the linked Read the Docs external-dependencies documentation and inspect how the replacement independent projects currently configure their documentation builds. Identify the documentation projects that need requirements files and confirm that each build uses locked dependencies so rendered documentation remains reproducible.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.