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

docs: Update mkdocs edit on github to work with addons #5164

Merged
merged 6 commits into from
Feb 26, 2025

Conversation

cwhite911
Copy link
Contributor

@cwhite911 cwhite911 commented Feb 20, 2025

Enables the material mkdocs edit and view on GitHub buttons to work with docs form grass-addons.

Address part of issue: #5158

To test you need to simulate what building the addons like PR #5152 .

  1. Make sure grass is built with the new md files.

  2. run /grass-addons/utils/cronjobs_osgeo_lxd/compile_addons_git.sh #PR cronjobs: Add Markdown and generalize addon build grass-addons#1330

./grass-addons/utils/cronjobs_osgeo_lxd/compile_addons_git.sh 8 5 $(pwd)/grass-addons/src $(pwd)/grass $(pwd)/grass-addons/addons-build-dir grass
  1. Copy the build addons docs to the dist directory of grass core.
cp grass-addons/addons-build-dir/docs/md/source/* grass/dist.x86_64-pc-linux-gnu/docs/mkdocs/source/addon
  1. In grass core cd into the man directory and run the mkdocs server
cd man && make serve-mkdocs

image

@cwhite911 cwhite911 requested a review from wenzeslaus February 20, 2025 21:58
@cwhite911 cwhite911 self-assigned this Feb 20, 2025
@github-actions github-actions bot added Python Related code is in Python HTML Related code is in HTML docs labels Feb 20, 2025
@cwhite911
Copy link
Contributor Author

This PR is dependent on #5177

@wenzeslaus
Copy link
Member

With #5152 and OSGeo/grass-addons#1330 merged, this should run nicely in CI and create an artifact.

Copy link
Member

@wenzeslaus wenzeslaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The edit works with both core and addon tools in the artifact. The added code complexity seems reasonable given we need two different repos.

@wenzeslaus wenzeslaus merged commit 99ed5dd into OSGeo:main Feb 26, 2025
29 checks passed
@github-actions github-actions bot added this to the 8.5.0 milestone Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs HTML Related code is in HTML Python Related code is in Python
Projects
Development

Successfully merging this pull request may close these issues.

2 participants