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.

Sign up for GitHub

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

Jump to bottom

Move mkdocs-macros boilerplate from the template to the library #179

Open
llucax opened this issue Nov 22, 2023 · 1 comment · May be fixed by #349
Open

Move mkdocs-macros boilerplate from the template to the library #179

llucax opened this issue Nov 22, 2023 · 1 comment · May be fixed by #349
Assignees
@llucax
Labels
priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Milestone
Untriaged

Comments

@llucax
Copy link
Contributor

llucax commented Nov 22, 2023

What's needed?

We need to remove the boilerplate code (_slugify(), hack to plug to mkdocstrings, etc) from the template to reduce the noise and repetition.

Proposed solution

Move the clutter from cookiecutter/\{\{cookiecutter.github_repo_name\}\}/docs/_scripts/macros.py to src/frequenz/repo/config/mkdocs/macros.py.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response
@llucax llucax added the type:enhancement New feature or enhancement visitble to users label Nov 22, 2023
@llucax llucax added this to the v0.8.0 milestone Nov 22, 2023
@llucax llucax self-assigned this Nov 22, 2023
@llucax llucax modified the milestones: v0.8.0, v0.9.0 Dec 18, 2023
@llucax llucax modified the milestones: v0.9.0, v0.10.0 Feb 20, 2024
@llucax llucax modified the milestones: v0.10.0, v0.11.0 Jul 10, 2024
@llucax llucax modified the milestones: v0.11.0, v0.12.0 Nov 20, 2024
@llucax llucax mentioned this issue Feb 3, 2025
Merged
@llucax
Copy link
Contributor Author

llucax commented Feb 3, 2025

We should include this in the next release and provide a migration script. See #348 for details.

@llucax llucax added the priority:high Address this as soon as possible label Feb 3, 2025
@llucax llucax linked a pull request Feb 4, 2025 that will close this issue
Open
@llucax llucax modified the milestones: v0.12.0, Untriaged Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@llucax llucax

Labels
priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Projects
None yet
Milestone
Untriaged
Development

Successfully merging a pull request may close this issue.

Move mkdocstrings-macros integration to a library llucax/frequenz-repo-config-python
1 participant
@llucax