adafruit / adafruit/Adafruit_CircuitPython_Bundle

Libraries: docs/conf.py gives version as "1.0"

Open
#460 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
1k
Forks
205
Avg merge
5h 34m
Merged PRs (30d)
4

Description

All or nearly all the library `docs/conf.py` files contain this:
```py
# The short X.Y version.
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = "1.0"
```
This incorrect `1.0` version does not show up too many places, but it does show up in the HTML `` text, which shows up in search engine results, e.g.:

![image](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/assets/2847802/17146a7d-c01e-4253-beed-ce5c25b43d31)

There are various ways to fix this: https://stackoverflow.com/questions/26141851/let-sphinx-use-version-from-setup-py is one discussion I found.

To fix this would require an all-library patch, and also https://github.com/adafruit/cookiecutter-adafruit-circuitpython needs to be fixed.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the library docs/conf.py files and the cookiecutter-adafruit-circuitpython template mentioned in the issue. Trace where each library's version and release values should come from, update the relevant configurations across the bundle and template, and verify that generated HTML titles no longer show 1.0.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.