Merge pull request #58 from pharmaverse/zensical

Migrate from mkdocs-material to zensical

Author: nanxstats

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - run: pip install zensical mkdocstrings-python
+      - run: zensical build --clean
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment

.github/workflows/mkdocs.yml

@@ -11,3 +11,6 @@ wheels/
 
 # pytest
 .coverage
+
+# Zensical site
+/site/

.gitignore

@@ -6,11 +6,11 @@
 [![CI tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
 [![Mypy check](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml)
 [![Ruff check](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml)
-[![mkdocs](https://github.com/pharmaverse/py-pkglite/actions/workflows/mkdocs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
+[![Documentation](https://github.com/pharmaverse/py-pkglite/actions/workflows/docs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
 ![License](https://img.shields.io/pypi/l/pkglite)
 
-A simple framework for packing source projects of any language into portable
-text files and restoring them into the original directory structure.
+A simple framework for packing source projects of any programming language into
+portable text files and restoring them into the original directory structure.
 
 Besides the Python API, a command line interface is also provided.
 

README.md

@@ -6,11 +6,11 @@
 [![CI tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
 [![Mypy check](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml)
 [![Ruff check](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml)
-[![mkdocs](https://github.com/pharmaverse/py-pkglite/actions/workflows/mkdocs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
+[![Documentation](https://github.com/pharmaverse/py-pkglite/actions/workflows/docs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
 ![License](https://img.shields.io/pypi/l/pkglite)
 
-A simple framework for packing source projects of any language into portable
-text files and restoring them into the original directory structure.
+A simple framework for packing source projects of any programming language into
+portable text files and restoring them into the original directory structure.
 
 Besides the Python API, a command line interface is also provided.
 

docs/assets/SourceSans3-Variable-Italic.woff2

@@ -5,5 +5,3 @@
       members:
         - is_text_file
         - classify_file
-      show_root_heading: true
-      show_source: false

docs/assets/SourceSans3-Variable.woff2

@@ -4,5 +4,3 @@
     options:
       members:
         - pack
-      show_root_heading: true
-      show_source: false

docs/index.md

@@ -4,5 +4,3 @@
     options:
       members:
         - unpack
-      show_root_heading: true
-      show_source: false