MoirePy/mkdocs.yml at main · jabed-umar/MoirePy · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
site_name: MoirePy – Python Library for Moiré Lattice Simulation
site_description: "MoirePy is a Python library for bilayer moiré lattice simulations using tight-binding models. Open-source, installable via PyPI."
site_url: https://jabed-umar.github.io/MoirePy/
repo_url: https://github.com/jabed-umar/MoirePy
repo_name: jabed-umar/MoirePy

theme:
  name: material
  logo: assets/logo.svg
  # favicon: images/logo/favicon.png
  features:
    # - navigation.expand
    - navigation.sections

  palette:
    - scheme: slate
      primary: black
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

    - scheme: default
      primary: white
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            # This is the single biggest fix for "pretty" parameters
            docstring_section_style: table
            show_root_heading: false
            show_source: false
            # Separates the function name from its arguments for clarity
            separate_signature: true
            # Styles 'See Also' and 'Notes' more distinctly
            merge_init_into_class: true
  - bibtex:
      bib_file: docs/refs.bib

extra_css:
  - assets/style.css
  - assets/replications.css

# extra_javascript:
#   - assets/script_find_theta.js

extra:
  notebooks_to_convert:
    - getting_started/quickstart_tbg.ipynb
    - getting_started/k_space_hamiltonian.ipynb
    - getting_started/obc_vs_pbc.ipynb
    - getting_started/prepare_layers.ipynb
    - getting_started/custom_hoppings.ipynb
    - getting_started/multiple_orbitals.ipynb
    - getting_started/non_hermitian.ipynb

    - replications/nori.ipynb
    - replications/koshino.ipynb

    - examples/tight_binding_ham.ipynb
    - examples/dos_calculation.ipynb


nav:
  - Home: index.md
  - Getting Started:
    - Quickstart TBG in 5 Minutes: getting_started/quickstart_tbg.md
    - K-Space Hamiltonian Generation: getting_started/k_space_hamiltonian.md
    - Designing Custom Hopping: getting_started/custom_hoppings.md
    - Defining Custom Layers: getting_started/prepare_layers.md
    - Lattices in Open vs. Periodic Boundary Conditions: getting_started/obc_vs_pbc.md
    - Multiple-Orbital Systems: getting_started/multiple_orbitals.md
    - Non-Hermitian Systems: getting_started/non_hermitian.md
  - Examples and Benchmarks:
    - Replicated Papers: replications.md
    - Benchmarks: benchmarks.md
  - Theory of Algorithms:
    - Searching Algorithm & KDTree: theory/search_algorithm_kdtree.md
    - Angle Calculation Logic: theory/angle_calculation_process.md
    - Angle Value Calculator: theory/avc.md
  # - "Theory: Physics":
  #   - Tight Binding Formulation: theory_physics/tight_binding_ham.md
  - API Reference:
    - Overview: api/index.md
    - Core Classes:
      - Layer: api/generated/moirepy.layers.Layer.md
      - BilayerMoireLattice: api/generated/moirepy.moire.BilayerMoireLattice.md
    - Built-in Layers:
      - SquareLayer: api/generated/moirepy.layers.SquareLayer.md
      - TriangularLayer: api/generated/moirepy.layers.TriangularLayer.md
      - Rhombus60Layer: api/generated/moirepy.layers.Rhombus60Layer.md
      - KagomeLayer: api/generated/moirepy.layers.KagomeLayer.md
      - HexagonalLayer: api/generated/moirepy.layers.HexagonalLayer.md
    - Utilities:
      - get_rotation_matrix: api/generated/moirepy.utils.get_rotation_matrix.md
      - are_coeffs_integers: api/generated/moirepy.utils.are_coeffs_integers.md
      - LatticeAlreadyFinalisedError: api/generated/moirepy.utils.LatticeAlreadyFinalisedError.md

markdown_extensions:
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

hooks:
  - mkdocs_hooks.py