update doc tooling to Zensical (#44)

* update to Zensical

* update CI

Author: tomkralidis

.github/workflows/deploy.yml

@@ -16,6 +16,22 @@ jobs:
       - name: Install requirements 📦
         run: |
           python3 -m pip install --upgrade pip
-          pip3 install mkdocs
-      - name: Deploy 📦
-        run: mkdocs gh-deploy --force -m 'update website'
+          pip3 install zensical
+      - name: Build site 📦
+        run: |
+          zensical build --clean --strict
+          mv site /tmp/
+      - name: checkout gh-pages branch
+        uses: actions/checkout@master
+        with:
+          ref: gh-pages
+      - name: Deploy to GitHub Pages 📦
+        run: |
+          git checkout gh-pages
+          git config --global user.email "tomkralidis@gmail.com"
+          git config --global user.name "Tom Kralidis"
+          ls | grep -v ".nojekyll"| xargs rm -fr
+          mv -f /tmp/site/* .
+          git add .
+          git commit -am "update website via GitHub Actions"
+          git push

.github/workflows/test.yml

@@ -10,13 +10,13 @@ jobs:
     name: Test website build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@master
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
       - name: Install requirements 📦
         run: |
           python3 -m pip install --upgrade pip
-          pip3 install mkdocs
+          pip3 install zensical
       - name: Test build 📦
-        run: mkdocs build --strict
+        run: zensical build --clean --strict

README.md

@@ -4,7 +4,7 @@
 # pygeoapi.io website
 
 The pygeoapi [website](https://pygeoapi.io) is powered
-by [MkDocs](https://www.mkdocs.org) which facilitates easy management
+by [Zensical](https://zensical.org) which facilitates easy management
 of website content and publishing.
 
 ## Setting up the website environment locally
@@ -19,9 +19,9 @@ cd pygeoapi.io
 # install required dependencies
 pip3 install -r requirements.txt
 # build the website
-mkdocs build
+zensical build --clean --strict
 # serve locally
-mkdocs serve  # website is made available on http://localhost:8000/
+zensical serve  # website is made available on http://localhost:8000/
 ```
 
 ## Content management workflow
@@ -42,10 +42,10 @@ The basic workflow is as follows:
 
 ```bash
 vi docs/new-page.md  # add content
-vi mkdocs.yml  # add to navigation section
+vi zensical.toml  # add to navigation section
 # edit any other files necessary which may want to link to the new page
 git add docs/new-page.md
-git commit -m 'add new page on topic x' docs/new-page.md mkdocs.yml
+git commit -m 'add new page on topic x' docs/new-page.md zensical.toml
 git push origin master
 ```
 
@@ -59,10 +59,4 @@ git push origin master
 
 ## Publishing updates to the live site
 
-Website updates are automatically published via GitHub Actions, but just in case:
-
-```bash
-# NOTE: you require access privileges to the GitHub repository
-# to publish live updates
-mkdocs gh-deploy -m 'add new page on topic x'
-```
+Website updates are automatically published via GitHub Actions.

mkdocs.yml

@@ -49,7 +49,7 @@
       <a rel="license" title="This work is licensed under a Creative Commons Attribution 4.0 International License" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a>
       {{ config.copyright }}
       <a title="Open Hub project report for pygeoapi" href="https://www.openhub.net/p/pygeoapi"><img src="https://www.openhub.net/p/pygeoapi/widgets/project_thin_badge.gif"/></a>
-      <br/>Powered by <a href="https://www.mkdocs.org/">MkDocs</a>
+      <br/>Powered by <a href="https://zensical.org/">Zensical</a>
     </footer>
   </body>
 </html>

pygeoapi.io-theme/main.html

@@ -1 +1 @@
-mkdocs
+zensical

requirements.txt

@@ -0,0 +1,26 @@
+[project]
+site_name = "pygeoapi"
+site_description = "pygeoapi: an OGC API to geospatial data"
+site_author = "the pygeoapi community"
+copyright = "© 2019 - 2026 pygeoapi development team"
+site_url = "https://pygeoapi.io"
+repo_url = "https://github.com/geopython/pygeoapi.io"
+docs_dir = "docs"
+directory_urls = true
+
+nav = [
+    { "Home" = "index.md"},
+    { "Community" = "community/index.md"},
+    { "Documentation" = "documentation.md"},
+    { "Demo" = "https://demo.pygeoapi.io"},
+    { "Code" = "https://github.com/geopython/pygeoapi"},
+    { "Download" = "download.md"},
+    { "Development" = "development/index.md"}
+]
+
+
+[project.theme]
+    custom_dir = "pygeoapi.io-theme"
+
+[project.extra]
+homepage = "https://pygeoapi.io"