ni / ni/ni-apis-python

ni-apis-python ReadTheDocs projects do not have a "stable" version

Open
#337 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug triage
Dominant language
Python
Stars
7
Forks
2
Avg merge
1d 18h
Merged PRs (30d)
3

Description

Bug Report

Normally, ReadTheDocs displays both a "latest" version corresponding to the main branch and a "stable" version corresponding to the most recent release tag. Showing the "stable" version by default and using it in hyperlinks avoids showing customers information about unreleased changes.

Because ni-apis-python is a monorepo, ReadTheDocs does not recognize any of its release tags, so it doesn't show a stable version.

See https://readthedocs-theme.readthedocs.io/en/latest/versions.html for more info.

Repro or Code Sample

Visit https://niprotobuftypes.readthedocs.io/en/stable/

Expected Behavior

It shows the documentation for the most recent release.

Current Behavior

It displays an HTTP 404 error.

Context

I am updating the InterSphinx mapping for https://measurement-plugin-python.readthedocs.io/en/stable/ and it errors out when I try to link to stable releases.

Your Environment

N/A

AB#3907496

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

Inspect the ReadTheDocs configuration for the ni-apis-python monorepo and its release-tag settings, then compare the affected project URLs with the documented version configuration. Done means the stable URL resolves to the most recent release and the InterSphinx mapping can link to it without a 404.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.