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

doc: Fix Markdown doc markup issues #5075

Closed
13 tasks done
wenzeslaus opened this issue Feb 9, 2025 · 2 comments
Closed
13 tasks done

doc: Fix Markdown doc markup issues #5075

wenzeslaus opened this issue Feb 9, 2025 · 2 comments
Labels
Milestone

Comments

@wenzeslaus
Copy link
Member

wenzeslaus commented Feb 9, 2025

While the documentation is still build from HTML files. Markdown files are now in the source code and needed additional modifications (#5057, #5064). Feel free to grab a small issue or your favorite tool, and fix what is needed.

Identifiable by a text search:

  • Turn what was originally dt into headings or item lists as needed. (See where dt is in the .html file, fix the corresponding .md file.)

Identified by Markdown linting (delete the line from .markdownlint.yaml and fix what is needed):

Harder to identify:

Additional issues:

  • WARNING - Doc file 'imageryintro.md' contains a link 'band_references_scheme.png', but the target is not found among documentation files.
  • INFO - Doc file 'r.mapcalc.md' contains a link 'rasterintro.md#raster-format', but the doc 'rasterintro.md' does not contain an anchor '#raster-format'.

Additional info

The nice thing about Markdown is that many tools including GitHub can display it (or you even don't have to). If you want to build the resulting documentation anyway, see #5048.

The mkdocs build has some issues too. They are tracked in #5058.

The deployment of mkdocs and Markdown files for grass-addons are not yet tracked in separate issues.

@echoix
Copy link
Member

echoix commented Feb 9, 2025

That sounds like some stuff I could try tomorrow, instead of making pytest work on grass-addons..

@wenzeslaus
Copy link
Member Author

Cool. This is done. If you see issues with the syntax or how it is rendered, please fix or report.

Issue in addons for the same stuff:

OSGeo/grass-addons#1333

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

2 participants