Skip to content

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

Open
@dhalbert

Description

@dhalbert

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions