doc: Enable Markdown doc compilation #5048
Draft
+160
−37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The initial commit simply uncoments the Markdown compilation lines from OSGeo#3849. This requires the actual Markdown files to be present, so this breaks the CI. This will stay like this for now. The PR is mean to be tested together with the Markdown files generated by script in OSGeo#4620 (switch to this branch after generating the files). Subsequent commits will add fixes of the compilation (missing tools, files, etc.).
…eral and assumes that HTML will be eventually removed (the thumbnails are generated twice now, once for HTML and once of Markdown).
github-actions
bot
added
raster
…Markdown, so always do replacements.
…erscore just like in the HTML version.
15 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -83,6 +84,11 @@ | |||
| font-style: italic; | |||
| } | |||
| </style> | |||
| """ | |||
|
|
|||
| header_graphical_index_tmpl = f"""\ | |||
There was a problem hiding this comment.
[ruff] reported by reviewdog 🐶
Suggested change
| header_graphical_index_tmpl = f"""\ | |
| header_graphical_index_tmpl = f"""\ |
| short_family, module_family, imgs, year=year, skip_no_image=False | ||
| ) | ||
| else: | ||
| raise ValueError(f"Unknown format: {output_format}") |
There was a problem hiding this comment.
[ruff] reported by reviewdog 🐶
Suggested change
| raise ValueError(f"Unknown format: {output_format}") | |
| msg = f"Unknown format: {output_format}" | |
| raise ValueError(msg) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The initial commit simply uncoments the Markdown compilation lines from #3849. This requires the actual Markdown files to be present, so this breaks the CI. This will stay like this for now. The PR is mean to be tested together with the Markdown files generated by script in #4620 (switch to this branch after generating the files).
Subsequent commits will add fixes of the compilation (missing tools, files, etc.).