pbcgraph/mkdocs.yml at main · DeloneCommons/pbcgraph · 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
site_name: pbcgraph
site_description: Translation-labeled periodic graphs on Z^d with component lattice invariants.
site_url: https://delonecommons.github.io/pbcgraph/
repo_url: https://github.com/DeloneCommons/pbcgraph
repo_name: DeloneCommons/pbcgraph

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - content.code.copy

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.highlight
  # Make list rendering closer to what users expect from CommonMark/GitHub.
  - sane_lists
  # Math rendering (MathJax)
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      check_paths: true

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocs-jupyter:
      execute: true
      allow_errors: false
      include_source: true
      kernel_name: python3
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: false
            show_signature_annotations: true
            separate_signature: true
            members_order: source

nav:
  - General:
      - Overview: index.md
      - Concepts: general/concepts.md
      - Theory: general/theory.md
      - Choosing a container: general/graph_types.md
      - Roadmap: general/roadmap.md
  - Examples:
      - Quickstart: examples/quickstart.ipynb
      - Lift patch: examples/lift_patch.ipynb
      - Canonical lift: examples/canonical_lift.ipynb
      - Smith Normal Form (SNF): examples/snf.ipynb
  - API:
      - Reference: api/index.md
      - Graphs: api/graphs.md
      - Components: api/component.md
      - Algorithms: api/algorithms.md
      - Types: api/types.md
      - Exceptions: api/exceptions.md
  - Changelog: changelog.md