forked from anand-avinash/BrahMap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yaml
112 lines (99 loc) · 4.41 KB
/
mkdocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# A note for mkdocs:
# See <https://realpython.com/python-project-documentation-with-mkdocs/>
# and <https://www.mkdocs.org/user-guide/deploying-your-docs/>
# `mkdocs serve`: It creates a test documentation and makes it available at localhost. All the changes made to the documentation are propagated instantly to assist the development.
# `mkdocs build`: It build the complete static documentation pages along with html files and static assets. Committing it to the repo ensures that the self contained documentation pages are packaged with the package. However, it is not enough to host the documentation on github.
# `mkdocs gh-deploy`: GitHub repositories automatically serve static content when committed to a branch named `gh-pages`. The command `mkdocs gh-deploy` just does that by rebuilding the documentation from markdown files and docstrings, then commits them to the `gh-pages` branch and pushes it to the `gh-pages` branch on remote. Be aware that you will not be able to review the built site before it is pushed to GitHub. Therefore, you may want to verify any changes you make to the docs beforehand by using the `build` or `serve` commands and reviewing the built files locally. **If there are untracked files or uncommitted work in the local repository where mkdocs gh-deploy is run, these will be included in the pages that are deployed.**
# So follow the following workflow:
# 1. Make changes to the repository. Review any changes to documentation with `mkdocs serve`.
# 2. Build the documentation with `mkdocs build`. --->>> I have now added a pre-commit hook for it, so no need to run it explicitly. Now simply run `pre-commit run --all-files` for testing.
# 3. Commit the changes and new documentation.
# 4. Run `mkdocs gh-deploy` to deploy the documentation to github. --->>> I have deployed a github workflow to initiate `mkdocs gh-deploy` whenever a commit is pushed on the `main` branch on github. See <.github/workflow/documentation.yaml>
site_name: BrahMap Documentation
site_url: https://anand-avinash.github.io/BrahMap/
site_author: Avinash Anand, Giuseppe Puglisi
site_description: >-
An optimal map-making package for LiteBIRD
# Repository
repo_name: anand-avinash/BrahMap
repo_url: https://github.com/anand-avinash/BrahMap
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2024 Avinash Anand, Giuseppe Puglisi
theme:
name: "material"
icon:
repo: fontawesome/brands/github
features:
- content.code.copy
- search.suggest # search suggestion
- search.highlight # highlight the search terms
- navigation.top
- navigation.tabs
- navigation.expand
- navigation.footer
- navigation.path
- navigation.top # Back to top button
- toc.follow
- content.action.view # view source of this page
- content.action.edit # edit source of this page, related to `edit_uri`
# - navigation.sections
# - navigation.tracking # to track the address of the page with the active anchor
# - header.autohide
palette:
# - media: "(prefers-color-scheme)"
# toggle:
# icon: material/link
# name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to system preference
markdown_extensions:
### Matjax support
- pymdownx.arithmatex:
generic: true
### Code highlighting
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
### TOC permalink
- toc:
permalink: true
### Matjax support
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
### Enable docstring parsing
- mkdocstrings
# handlers:
# python:
# options:
# docstring_style: google
- search # Enable search
### Page tree
nav:
- Home: index.md
- Quick start: quick_start.md
- API References:
- api_references.md
- Interfaces:
- Linear operators: api_ref/interfaces/linearoperators.md
- Utilities: api_ref/utilities.md
- linop package: api_ref/linop.md