Skip to content

Missing version information in generated Sphinx docs #187

@ethanholz

Description

@ethanholz

When running the cookiecutter for the first time, the generated Sphinx docs have an empty version and release item. When running the sphinx-quickstart, the release tag is asked and set accordingly. Currently, there is no templated item used to add these fields.

Using sphinx-quickstart the following is generated in the conf.py file:

release = '<whatever you set the version to in the guided quickstart>'

In the current implementation of this project this is generated in the conf.py:

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''

Ideally, this would be fixed by providing the option for users to specify the version they want to initialize their project with rather than requiring it to being preset to 0.0.0. This creates some level of flexibility for projects that might not want to use semantic versioning but might want to use something like calendar versioning instead. Keeping the default to 0.0.0 is still fine, but the option could be nice. If this is asked during the creation process, templating the the release in the Sphinx docs should be easy to set.

To note, I am interested in contributing this change if the community and project are open to the new functionality/change!

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