doc: Enable Markdown doc compilation #5048
Merged
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.
16 tasks
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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>
|
This now builds Markdown files in dist based on the HTML-based .md files in the code (without a need to generate the files). |
|
When this is merged, |
13 tasks
|
Looking at the previous failure on Ubuntu: The tests run locally. @echoix , are these tests running in parallel perhaps? |
|
I'm not sure I understand. Can you point me on what lines of a job log you're talking about ? It shouldn't appear on the main repo... If it's the 4 Ubuntu jobs, no, it's not in parallel, it's pure gunittest. |
|
It only runs in parallel if it's pytest, and you use the plugin pytest-xdist. |
cwhite911
reviewed
Feb 11, 2025
There was a problem hiding this comment.
The docs are looking really good. I only had a few comments and suggest adding the following make command to man/Makefile for local testing.
serve-mkdocs:
@cd $(MDDIR) ; SITE_NAME="GRASS GIS $(GRASS_VERSION_NUMBER) Reference Manual" \
COPYRIGHT="© 2003-$(GRASS_VERSION_DATE) GRASS Development Team, GRASS GIS $(GRASS_VERSION_NUMBER) Reference Manual" \
mkdocs serve
Please, create a new PR for this after this is merged. |
petrasovaa
approved these changes
Feb 11, 2025
cwhite911
approved these changes
Feb 11, 2025
wenzeslaus
added a commit
that referenced
this pull request
Feb 13, 2025
…#5098) The original dependency handling between r.color and r.mapcalc from fd7d0ec and 9e56f6c uses dependency on binaries and builds r.mapcalc ahead of time. The new build code defines dependency between r.color and r.mapcalc subdir phony targets. This fixes the new issue which arose in #5048 with the Markdown documentation where r.colors build failed because r.mapcalc gave permission denied. I temporarily fixed the issue in #5048 by removing r.mapcalc from SUBDIRS. However, the change broke the recompilation with distclean not tested in CI). The new approach with explicit subdir phony target dependency avoids both issues.
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.).
To test this (assuming you already have the Markdown files):
Get virtual environment in some way (venv or pipenv).
Install dependencies:
Compile everything: