Skip to content

Commit 964f144

Browse files
Update Docs Generation
Update mkdocs configuration settings Replace GitHub workflow for documentation build Add javascript directory - custom webpage scripts - Added files provide support for formulas Add stylesheet directory - custom webpage stylization Move overrides directory to proper location
1 parent 80b5089 commit 964f144

File tree

10 files changed

+1010
-70
lines changed

10 files changed

+1010
-70
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Build Documentation
2+
3+
on:
4+
# Allows you to run this workflow manually from the Actions tab
5+
workflow_dispatch:
6+
branches: ["main"]
7+
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
10+
permissions:
11+
contents: write
12+
13+
14+
jobs:
15+
deploy:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
with:
22+
fetch-depth: 0
23+
24+
- name: Instal pgnquant for optimize plugin
25+
run: sudo apt-get install pngquant
26+
27+
- name: Set up Python runtime
28+
uses: actions/setup-python@v5
29+
with:
30+
python-version: 3.x
31+
32+
- name: Install Python dependencies
33+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
34+
35+
- name: Set up build cache
36+
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
37+
- uses: actions/cache@v4
38+
with:
39+
key: mkdocs-material-${{ env.cache_id }}
40+
path: .cache
41+
restore-keys: |
42+
mkdocs-material-
43+
44+
- name: Install Insiders build
45+
env:
46+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
47+
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
48+
- run: mkdocs gh-deploy --clean

.github/workflows/mkdocs.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/javascript/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
javascript directory
2+
====================
3+
This folder should contain the files for scripts to be included for the webpage

docs/javascript/katex.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
document$.subscribe(({ body }) => {
2+
renderMathInElement(body, {
3+
delimiters: [
4+
{ left: "$$", right: "$$", display: true },
5+
{ left: "$", right: "$", display: false },
6+
{ left: "\\(", right: "\\)", display: false },
7+
{ left: "\\[", right: "\\]", display: true }
8+
],
9+
})
10+
})

docs/javascript/mathjax.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true,
7+
// No Equation Numbering
8+
tags: 'none'
9+
},
10+
options: {
11+
ignoreHtmlClass: ".*|",
12+
processHtmlClass: "arithmatex"
13+
}
14+
};
15+
16+
document$.subscribe(() => {
17+
MathJax.typesetPromise()
18+
})
19+

docs/stylesheet/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
stylesheet directory
2+
====================
3+
This folder should contain the files used for the webpage customizations of the product documentation

0 commit comments

Comments
 (0)