roughness/mkdocs.yml at main · NAU-PIXEL/roughness · GitHub

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
---
# Project Information
site_name: Roughness
site_url: https://nau-pixel.github.io/roughness
site_author: Christian Tai Udovicic
site_description: Documentation for the roughness python package.

# Repository information
repo_name: NAU-PIXEL/roughness
repo_url: https://github.com/NAU-PIXEL/roughness
edit_uri: "edit/main/docs/"

# Copyright
copyright: Copyright &copy; 2023 Christian Tai Udovicic

# Configuration
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    view: material/eye
  features:
    - navigation.instant
    - navigation.tabs
  language: en

plugins:
  - search
  - gen-files:
      scripts:
      - docs/gen_api_pages.py
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [roughness]
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocs-jupyter:
      include_source: true
      execute: true
      allow_errors: false

# Footer
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nau-pixel
      name: NAU-PIXEL on GitHub

# Page tree
nav:
  - Home: index.md
  - 'User Guide':
    - 'Getting Started': 'getting_started.md'
    - 'Shadow Tables': 'shadow_tables.ipynb'
    - 'Rough emission': 'rough_emission.ipynb'
  - About: about.md
  - Code Reference: reference/

not_in_nav: |
  gen_api_pages.py

# Enable math (req. python-markdown-math)
extra_javascript:
  - docs/javascript/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true