File tree Expand file tree Collapse file tree 3 files changed +94
-0
lines changed
Expand file tree Collapse file tree 3 files changed +94
-0
lines changed Original file line number Diff line number Diff line change 1+ name : Deploy Docs to Pages
2+
3+ on :
4+ workflow_dispatch :
5+ push :
6+ branches : [ "main" ] # or "develop"
7+ # optional schedule:
8+ # schedule:
9+ # - cron: "0 0 * * 6"
10+
11+ jobs :
12+ docs :
13+ runs-on : ubuntu-latest
14+ steps :
15+ - uses : actions/checkout@v4
16+
17+ - uses : actions/setup-python@v5
18+ with :
19+ python-version : " 3.11"
20+
21+ - name : Install dependencies
22+ run : |
23+ python -m pip install --upgrade pip
24+ pip install -r docs/requirements.txt
25+ # if you want mkdocstrings to import your package:
26+ pip install .
27+
28+ - name : Deploy
29+ run : mkdocs gh-deploy --force
Original file line number Diff line number Diff line change 1+ site_name : DUNE Run Control (drunc) Developer Documentation
2+
3+ repo_name : DUNE-DAQ/drunc
4+ repo_url : https://github.com/DUNE-DAQ/drunc
5+
6+ theme :
7+ name : material
8+ palette :
9+ # Palette toggle for light/dark mode
10+ - scheme : default
11+ toggle :
12+ icon : material/lightbulb
13+ name : Switch to dark mode
14+ - scheme : slate
15+ toggle :
16+ icon : material/lightbulb-outline
17+ name : Switch to light mode
18+ icon :
19+ repo : fontawesome/brands/git-alt
20+
21+
22+ markdown_extensions :
23+ - admonition
24+ - pymdownx.highlight :
25+ anchor_linenums : true
26+ line_spans : __span
27+ pygments_lang_class : true
28+ - pymdownx.inlinehilite
29+ - pymdownx.snippets
30+ - pymdownx.superfences
31+
32+ plugins :
33+ - search
34+ - exclude :
35+ glob :
36+ - Developer-Wiki/*
37+ - gen-files :
38+ # scripts:
39+ # - docs/utils/generate_ghpages_docstrings.py
40+ - literate-nav :
41+ nav_file : README.md
42+ - section-index
43+ - mkdocstrings :
44+ default_handler : python
45+ handlers :
46+ python :
47+ options :
48+ show_source : true
49+ show_root_heading : true
50+ show_category_heading : true
51+ merge_init_into_class : true
52+ paths : [.]
53+
54+ # hooks:
55+ # - docs/utils/mkdocs_hooks.py
Original file line number Diff line number Diff line change 1+ mkdocs
2+ mkdocs-material
3+ mkdocs-mermaid2-plugin
4+ mkdocs-gen-files
5+ mkdocs-literate-nav
6+ mkdocs-section-index
7+ mkdocstrings
8+ mkdocstrings-python
9+ pymdown-extensions
10+ mkdocs-exclude
You can’t perform that action at this time.
0 commit comments