-
-
Notifications
You must be signed in to change notification settings - Fork 333
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: Enable Markdown doc compilation #5048
base: main
Are you sure you want to change the base?
Conversation
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).
…Markdown, so always do replacements.
…erscore just like in the HTML version.
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, |
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. |
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.
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
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.
The topics page is functional, but we should improve the design in another PR.
@@ -44,7 +44,6 @@ SUBDIRS = \ | |||
r.latlong \ | |||
r.lake \ | |||
r.li \ | |||
r.mapcalc \ |
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.
Why remove r.mapcalc
? I was having an issue building because the previous r.mapcalc dist wasn't getting removed with make distclean
, so I needed to manually remove it.
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: