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

Missing version information in generated Sphinx docs #187

Open
ethanholz opened this issue Mar 22, 2024 · 0 comments
Open

Missing version information in generated Sphinx docs #187

ethanholz opened this issue Mar 22, 2024 · 0 comments

Comments

@ethanholz
Copy link
Contributor

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!

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