Skip to content

Use mkdocs-macros to get the current version for the docs #138

@llucax

Description

@llucax

What's needed?

The docs are sometimes getting outdated in the examples on how to create a project based on the cookiecutter template, as we are using a tag for checkout.

Proposed solution

Get the current version automatically by using mkdocs-macros, which provide easy access to the git info:

Example on setting up mkdocs-macros:

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Assignees

Labels

part:docsAffects the documentationpart:mkdocsAffects the configuration of mkdocspart:toolingAffects the development tooling (CI, deployment, dependency management, etc.)type:enhancementNew feature or enhancement visitble to users

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions