initial

.github/workflows/build-documentations.yml

@@ -0,0 +1,24 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v3
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PYTHONPATH: ${{github.workspace}}
+          CUSTOM_DOMAIN: docu.lycee-experimental.org
+          CONFIG_FILE: mkdocs.yml
+          EXTRA_PACKAGES: build-base
+          # GITHUB_DOMAIN: github.myenterprise.com
+          REQUIREMENTS: mkdocs-pip.txt

.gitignore

@@ -0,0 +1,6 @@
+# docs
+docs-build
+.idea
+__pycache__/
+__pycache__/main.cpython-38.pyc
+.vscode/settings.json

children_toc_extension.py

@@ -0,0 +1,44 @@
+from markdown.extensions.toc import TocExtension
+from markdown.treeprocessors import Treeprocessor
+from markdown.extensions import Extension
+
+class ChildTocTreeprocessor(Treeprocessor):
+    def __init__(self, page):
+        self.page = page
+        super().__init__()
+
+    def run(self, root):
+        # Get the current page
+        page = self.page
+        if not page or not page.children:
+            return
+
+        # Create a new TOC extension
+        toc_extension = TocExtension()
+
+        # Generate a TOC for each child page and insert it into the parse tree
+        for child_page in page.children:
+            child_toc = toc_extension.build_toc_tree(child_page.content)
+            if child_toc:
+                toc_heading = self.md.htmlStash.store('<h2>{}</h2>'.format(child_page.title))
+                child_toc.insert(0, toc_heading)
+                root.append(child_toc)
+
+class ChildTocExtension(Extension):
+    def __init__(self, page=None, title='Child Pages', **kwargs):
+        self.config = {
+            'title': [title, 'Title to display above child page TOCs']
+        }
+        self.page = page
+        super().__init__(**kwargs)
+
+    def extendMarkdown(self, md):
+        md.registerExtension(self)
+        md.treeprocessors.register(ChildTocTreeprocessor(self.page), 'childtoc', 25)
+
+        # Add the title to the global TOC
+        title = self.getConfig('title')[0]
+        toc = md.toc
+        toc = toc.replace('</nav>', '</nav><h2>{}</h2>'.format(title))
+        md.toc = toc
+

custom_fences.py

@@ -0,0 +1,2 @@
+def custom_formatter(source, language, css_class, options, md, classes=None, id_value='', attrs=None, **kwargs):
+    return '```'+css_class+'\n'+source+'\n```'