Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dhalbert opened this issue May 3, 2024 · 0 comments
Open

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

dhalbert opened this issue May 3, 2024 · 0 comments

Comments

@dhalbert
Copy link
Contributor

dhalbert commented May 3, 2024

All or nearly all the library docs/conf.py files contain this:

# 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 <title> text, which shows up in search engine results, e.g.:

image

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant