Skip to content

update doc tooling to Zensical#223

Merged
tomkralidis merged 3 commits intomainfrom
zensical
Mar 11, 2026
Merged

update doc tooling to Zensical#223
tomkralidis merged 3 commits intomainfrom
zensical

Conversation

@tomkralidis
Copy link
Member

@tomkralidis tomkralidis commented Mar 9, 2026

This PR updates doc build/tooling from MkDocs to Zensical (rationale).

Notes:

@tomkralidis tomkralidis added this to the FOSS4G Europe 2026 milestone Mar 9, 2026
@tomkralidis tomkralidis added the documentation Improvements or additions to documentation label Mar 9, 2026
Copy link
Member

@justb4 justb4 left a comment

Choose a reason for hiding this comment

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

Yes, I read the rationale, was not aware. Will impact quite some projects, but mkdocs 2.0 is an uncertain (FOSS) path.
Think will miss first the Material design, or is that in here? Zensical are its authors btw.
And i18n? We can do without termy..

The "Doing Geospatial in Python" has already been done, result here:
https://geopython.github.io/geopython-workshop/ IMHO a bit barren, but maybe we should also go for a more lighter "text web". But why not, as a start, embellish later...I'll go with any flow..

@tomkralidis
Copy link
Member Author

@justb4 good points. The critical path is to ensure a safe arrival into Zensical before things get too stale in MkDocs proper. Note that the I've updated the PR to match the pygeoapi blue in the theming.

@doublebyte1
Copy link
Contributor

Yes, I read the rationale, was not aware. Will impact quite some projects, but mkdocs 2.0 is an uncertain (FOSS) path. Think will miss first the Material design, or is that in here? Zensical are its authors btw. And i18n? We can do without termy..

The "Doing Geospatial in Python" has already been done, result here: https://geopython.github.io/geopython-workshop/ IMHO a bit barren, but maybe we should also go for a more lighter "text web". But why not, as a start, embellish later...I'll go with any flow..

@justb4 I think internationalisation is now supported in the core, so we don't need a plugin.

@geographika
Copy link
Contributor

Thanks for the heads-up @tomkralidis. I'll look at following this update path with the MapServer workshop. I was never a fan of termynal anyway!

Issues like the mkdocs struggles highlight how good it is for a project to be part of something like OSGeo with PSCs and CoCs.

Copy link
Contributor

@doublebyte1 doublebyte1 left a comment

Choose a reason for hiding this comment

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

### Building the workshop content locally

The workshop manual is powered by [MkDocs](https://www.mkdocs.org) which facilitates easy management
The workshop manual is powered by [Zensical](https://zensical.org) which facilitates easy management
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe also add pip3 install --upgrade pip?

@tomkralidis tomkralidis merged commit 9aa7388 into main Mar 11, 2026
1 check passed
@tomkralidis tomkralidis deleted the zensical branch March 11, 2026 18:55
@tomkralidis
Copy link
Member Author

@doublebyte1 can you PR your branch (rebased against latest main, which includes this PR/merge)?

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants