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

docs: Added material mkdocs tags plugin #5153

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

cwhite911
Copy link
Contributor

Addresses Issue #5091

This pull request includes multiple changes to improve the documentation and tagging system in the project.

Modified md keyword generation in documentation:

Updates to build process and documentation files:

@cwhite911 cwhite911 self-assigned this Feb 19, 2025
@github-actions github-actions bot added C Related code is in C HTML Related code is in HTML libraries docs labels Feb 19, 2025
@wenzeslaus
Copy link
Member

While just using the tags instead of a currently working custom keywords system is not a priority, and some pieces will need to me preserved for keeping functioning URLs (if someone links https://grass.osgeo.org/grass-stable/manuals/keywords.html), this may help solving keywords for addons which currently work for HTML, but not for Markdown. However, given this needs the addon situation to be resolved, let's wait with this a bit to see how #5152 develops.

Example with a addon-only keyword is v.vect.stats.multi.md with keyword 'columns'.

@cwhite911
Copy link
Contributor Author

While just using the tags instead of a currently working custom keywords system is not a priority, and some pieces will need to me preserved for keeping functioning URLs (if someone links https://grass.osgeo.org/grass-stable/manuals/keywords.html), this may help solving keywords for addons which currently work for HTML, but not for Markdown.

This is an easy fix. We just need to leave the keyword tag in the header for now.

Example with a addon-only keyword is v.vect.stats.multi.md with keyword 'columns'.

I'll need to see this because I'm not following.

However, given this needs the addon situation to be resolved, let's wait with this a bit to see how #5152 develops.

I agree this can wait until we resolve the addons.

Copy link
Member

@wenzeslaus wenzeslaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it, but I meant to request changes for the footer.

@wenzeslaus
Copy link
Member

Please, update from main. #5152, #5177, and #5175 are now on main, so the custom keyword system including addons is in a good shape and running the the CI. Then, we can see the result in the artifact from the Documentation workflow.

@petrasovaa
Copy link
Contributor

petrasovaa commented Feb 25, 2025

The Tags index in the footer doesn't work, links to ./addons/tags.html, but that's the same for keywords.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C Related code is in C docs HTML Related code is in HTML libraries markdown
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

3 participants