-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
157 lines (143 loc) · 12.2 KB
/
mkdocs.yml
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
site_name: "physipy : make python unit-aware" # name of your documentation site, which will appear in the navigation and page titles
site_description: Official documentation for the physipy python package # This description may appear in search results or metadata
repo_url: https://github.com/mocquin/physipy/ # MAterial : In order to display a link to the repository of your project as part of your documentation
repo_name: mocquin/physipy # Material : MkDocs will infer the source provider by examining the URL and try to set the repository name automatically. If you wish to customize the name, set repo_name
use_directory_urls: false # see https://stackoverflow.com/questions/60354731/why-are-my-local-html-links-going-to-parent-folder-instead-of-the-html
docs_dir: docs # name of dir containing md files for docs. Defaults to docs
site_dir: _mkdocks_site # the directory where the output HTML and other files are created, Defaults to site
edit_uri: edit/master/docs # https://www.mkdocs.org/user-guide/configuration/#edit_uri
theme:
name: "material" # declare the theme use (defaults installed are readthedocs and mkdocs)
scheme: slate
palette: # optionnal coloration
# primary: teal
# accent: orange
#- scheme: default
# toggle:
# icon: material/brightness-5
# name: Switch to dark light
- scheme: default # Palette toggle for light mode
toggle:
icon: material/brightness-5
name: Switch to dark mode
- scheme: slate # Palette toggle for dark mode
toggle:
icon: material/brightness-7
name: Switch to light mode
features:
#- navigation.tabs # Material : When tabs are enabled, top-level sections are rendered in a menu layer below the header for viewports above 1220px, but remain as-is on mobile.1
#- navigation.tabs.sticky
#- navigation.sections # Material : When tabs are enabled, top-level sections are rendered in a menu layer below the header for viewports above 1220px, but remain as-is on mobile.
- navigation.top # A back-to-top button can be shown when the user, after scrolling down, starts to scroll up again. It's rendered centered and just below the header
#- navigation.expand # Material : When expansion is enabled, the left sidebar will expand all collapsible subsections by default, so the user doesn't have to open subsections manuall
- navigation.path # SPONSORS ONLY : When navigation paths are activated, a breadcrumb navigation is rendered above the title of each page, which might make orientation easier for users visiting your documentation on devices with smaller screens
- search.suggest # the search will display the likeliest completion for the last word which can be accepted with the Right key.
- search.highlight # When search highlighting is enabled and a user clicks on a search result, Material for MkDocs will highlight all occurrences after following the link
- search.share # When search sharing is activated, a share button is rendered next to the reset button, which allows to deep link to the current search query and result
- content.action.edit # Material/repo : button for edit on github (After making sure that edit_uri is correctly configured, buttons for code actions can be added.)
- content.action.view # Material/repo : button for viewing page on github
- toc.follow
- content.code.copy # Material/code blocks : Code blocks can automatically render a button on the right side to allow the user to copy a code block's contents to the clipboard
- content.code.select
icon:
repo: fontawesome/brands/github # Material/repo : While the default repository icon is a generic git icon, it can be set to any icon bundled with the theme by referencing a valid icon path
edit: material/pencil # Material/repo : icon for edit button
view: material/eye # Material/repo : icon for view button
logo: material/book # Material : icon for home button
# watch: # https://www.mkdocs.org/user-guide/configuration/#watch : Determines additional directories to watch when running mkdocs serve
# - ./../
watch: [mkdocs.yml, README.md, physipy/]
plugins: # TODO : try https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
#- mkdocs-jupyter: # https://github.com/danielfrg/mkdocs-jupyter
# ignore_h1_titles: false
# include: [] # Default: ["*.py", "*.ipynb"]
# ignore: ["some-irrelevant-files/*.ipynb"]
# execute: true
# allow_errors: false
# kernel_name: python3
# show_input: true
# no_input: false
# theme: dark
# execute_ignore:
# - "my-secret-files/*.ipynb"
- search
- mkdocstrings:
handlers:
python:
options:
show_submodules: true # To automaticaly generate sub-modules docstrings
show_sources: true
markdown_extensions:
- toc:
permalink: true
title: On this page # Name of toc, default to "Table of content"
toc_depth: 3 # define the range of levels to be included in the table of contents.
- markdown_include.include:
base_path: docs
- pymdownx.highlight: # The below block allows for code-block syntax colors
auto_title: false # This option will automatically add a title to all code blocks that shows the name of the language being used, e.g. Python is printed for a py block
use_pygments: true # This option allows to control whether highlighting should be carried out during build time using Pygments or in the browser with a JavaScript syntax highlighter
anchor_linenums: true # If a code blocks contains line numbers, enabling this setting will wrap them with anchor links, so they can be hyperlinked and shared more easily:
line_spans: __span # When this option is set, each line of a code block is wrapped in a span, which is essential for features like line highlighting to work correctly
pygments_lang_class: true
linenums: true # This option will add line numbers to all code blocks.
linenums_style: pymdownx-inline # pymdownx-inline renders line numbers as part of the line itself
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.arithmatex: # support for latex, along additionnal javascript below
generic: true
- attr_list # For inline button : This configuration allows to add attributes to all inline- and block-level elements with a simple syntax, turning any link into a button
nav: # All paths in the navigation configuration must be relative to the docs_dir configuration option
- physipy: index.md
- Installation : installation.md
- Quickstart : quickstart.md
- Scientific stack support:
- standard math module : scientific-stack/math-support.md
- numpy : scientific-stack/numpy-support.md
- matplotlib : scientific-stack/matplotlib-support.md
- pandas : scientific-stack/pandas-support.md
- scipy : scientific-stack/scipy-support.md
- Examples:
- Physics : examples/physics-examples.md
- Thermal equation using Finite Difference Method: examples/thermal-equation-using-fdm.md
- Fourier transform: examples/fourier-transform-example.md
- API reference:
- Introduction : API/api-reference.md
- Dimension : API/dimension-api.md
- Quantity : API/quantity-api.md
- Units : API/units-api.md
- Constants : API/constants-api.md
- Plotting : API/plotting-api.md
- Development and performance :
- General guidances : development-guide/index.md
- Benchmarking with AirSpeedVelocity : development-guide/dev-benchmarking-with-asv.md
- Performance and comparison with other packages : development-guide/dev-performance-comparison.md
- Performance of the Dimension class : development-guide/dev-performance-dimension.md
- Misc :
- Alternative packages:
- Alternative packages : misc/alternative-packages/alternative-home.md
- Pint : misc/alternative-packages/alternative-pint.md
- Astropy : misc/alternative-packages/alternative-astropy.md
- For all people : misc/alternative-packages/alternative-forallpeople.md
- Support for other value-packages :
- Support for the decimal module : misc/support-for-other-backend-packages/decimal-support.md
- Support for handcalcs : misc/support-for-other-backend-packages/handcalcs-support.md
- Support for mcerp : misc/support-for-other-backend-packages/mcerp-support.md
- Support for uncertainties : misc/support-for-other-backend-packages/uncertainties-support.md
- Testing jupyter notebooks :
- numpy notebook : scientific-stack/numpy-support-nb.ipynb
extra_javascript: # Following lines for mathjax, along with the ./docs/javascripts/mathjax.js
# - javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# end of mathjax block
# For additionnal css, like custom scheme
extra_css:
- stylesheets/extra.css
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/mocquin
- icon: fontawesome/brands/python
link: https://pypi.org/project/physipy/