-
-
Notifications
You must be signed in to change notification settings - Fork 391
MkDocs: Fixes missing Parameter tabs in documentation #6858
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
Conversation
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
gulshan-123
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please check if it renders properly in case of <, > ,*, and tab if present in str?
Or is it the case that these can never occur in str?
Yes, My PR only changed the tab ( For consistency, I will make a commit to change the manual |
|
Thanks for clarifying! I did not checked the macro expansion! I am +1 on using the macro instead of expansion to make it consistent with other part of code (and maybe to avoid confusion for people like me?) |
|
I think the newline is somewhat special case, so maybe moving it into a separate function G__md_print_escaped_newline or something like that may be better. I was thinking of replacing Not sure about the other change, it is unrelated. |
CI(deps): Update dependency sphinx to v9.1.0 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…o#6859) CI(deps): Update dependency pymdown-extensions to v10.20 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…20.1.0 (main) (OSGeo#6817) * CI(deps): Update pre-commit hook pre-commit/mirrors-clang-format to v20 * CQ: Apply clang-format 20 formatting * CI: Update DoozyX/clang-format-lint-action to use clang-format 20 * CQ: Change .clang-format config to define C language options (now different from Cpp) * CQ: Upgrade .clang-format config for renamed/deprecated option AlwaysBreakTemplateDeclarations * CQ: Remove Cpp-specific formatting options from C options * CQ: Downgrade clang-format to 20.1.0 to match existing clang-format action --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Edouard Choinière <[email protected]>
* wxGUI: Make Define new GRASS project wizard resizable * wxGUI: ellipsize GIS database path label in location wizard
|
Closing this PR as it became messy. Created fresh clean PR at #6864 with the requested changes. |
Fixes #6305
Problem Description
The Parameters section in MkDocs-generated documentation only displays the "Command line" tab for some modules like
v.out.ogr,v.in.ogretc., while the "Python (grass.script)" and "Python (grass.tools)" tabs are missing. This affects some module documentation pages built with Material for MkDocs.Root Cause
In
lib/gis/parser_md_common.c, theG__md_print_escaped()function was not adding proper indentation after line breaks (\n) in parameter descriptions. Material for MkDocs requires continuation lines within tab blocks to be indented with 4 spaces. Without this indentation, MkDocs exits the tab block prematurely, causing the remaining tabs to not render.Solution
Modified
G__md_print_escaped()to:fputs("\\\n ", f); ) with regular spaces for tab charactersTesting
v.out.ograndv.in.ogrmodulesdata-tabs="2:3"in generated HTML shows all 3 tabsBefore Fix
Only Command line tab visible

After Fix
All three tabs (Command line, Python grass.script, Python grass.tools) display correctly
