pylattica/mkdocs.yml at master · mcgalcode/pylattica · 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
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
site_name: pylattica documentation
site_description: Documentation for the pylattica package
copyright: Built by Max Gallant
watch:
  - src/pylattica
nav:
  - Home:
    - pylattica: index.md
    - Getting Started: ./guides/index.md
    - Reference: reference/core/lattice.md
    - Notebooks: ./examples/game_of_life.ipynb
    - Guides: ./guides/constructing_lattices.ipynb
  - Guides:
    - Getting Started: ./guides/index.md
    - Building Conway's Game Of Life: ./guides/game_of_life.ipynb
    - Lattices: ./guides/constructing_lattices.ipynb
    - Periodic Structures: ./guides/periodic_structures.ipynb
    - Neighborhoods: ./guides/neighborhoods.ipynb
    - Simulation States: ./guides/simulation_state.ipynb
    - Controllers and Update Rules: ./guides/controllers_and_update_rules.ipynb
    - Runners: ./guides/runners.ipynb
    - Square Grids: ./guides/square_grids.ipynb
    - Examples:
      - Life Like Demos: ./examples/life_like_demos.ipynb
  - Reference:
    - Core:
      - Runner:
        - SynchronousRunner: reference/core/runner/synchronous_runner.md
        - AsynchronousRunner: reference/core/runner/asynchronous_runner.md
      - PeriodicStructure: reference/core/periodic_structure.md
      - Lattice: reference/core/lattice.md
      - Coordinate Utilities: reference/core/coordinate_utils.md
      - Neighborhoods: reference/core/neighborhood.md
      - NeighborhoodBuilders: reference/core/neighborhood_builders.md
      - SimulationResult: reference/core/simulation_result.md
      - SimulationState: reference/core/simulation_state.md
      - Analyzer: reference/core/analyzer.md
      - BasicController: reference/core/basic_controller.md
      - DistanceMap: reference/core/distance_map.md
      - StructureBuilder: reference/core/structure_builder.md
      - Simulation: reference/core/simulation.md
    - Atomic:
      - PymatgenStructConverter: reference/atomic/pymatgen_struct_converter.md
    - Discrete:
      - DiscreteStepAnalyzer: reference/discrete/discrete_step_analyzer.md
      - DiscreteStateResultAnalyzer: reference/discrete/discrete_state_result_analyzer.md
      - PhaseSet: reference/discrete/phase_set.md
    - Structures:
      - SquareGrid:
        - GridSetup: reference/structures/square_grid/grid_setup.md
        - GrowthSetup: reference/structures/square_grid/growth_setup.md
        - Lattice: reference/structures/square_grid/lattice.md
        - Neighorboods: reference/structures/square_grid/neighborhoods.md
        - StructureBuilders: reference/structures/square_grid/structure_builders.md
      - Honeycomb:
        - Lattice: reference/structures/honeycomb/lattice.md
        - Neighorboods: reference/structures/honeycomb/neighborhoods.md
        - StructureBuilders: reference/structures/honeycomb/structure_builders.md
    - Visualization:
      - SquareGridArtist2D: reference/visualization/square_grid_artist_2D.md
      - SquareGridArtist3D: reference/visualization/square_grid_artist_3D.md
      - ResultArtist: reference/visualization/result_artist.md

repo_url: https://github.com/mcgalcode/pylattica/
repo_name: Github

theme:
  name: material
  icon:
    logo: material/currency-sign
  features:
    - navigation.tabs
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: purple

# extra_css:
#   - css/mkdocstrings.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist

plugins:
  - search
  - section-index
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          paths: ['src']
          setup_commands:
            - import sys
            - sys.path.append("docs")
          selection:
            new_path_syntax: yes