python-project-template/mkdocs.yml at main · Paul-B98/python-project-template · 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
site_name: Python Project # TODO change this to your project name
docs_dir: docs
copyright: Copyright &copy; 2023 Paul-B98 # TODO change this to your name

nav:
  - Getting Started:
      - Package Overview: "getting_started/overview.md"
      - Installation: "getting_started/installation.md"
      - Basic Usage: "getting_started/basic_usage.md"
      - Contributing: "getting_started/contributing.md"
  # - User Guide:
  - Architecture:
      - Introduction and Goals: "arc/introduction.md"
      - Architecture Constraints: "arc/constraints.md"
      - Context and Scope: "arc/context.md"
      - Solution Strategy: "arc/strategy.md"
      - Building Block View: "arc/building_block.md"
      - Runtime View: "arc/runtime.md"
      - Deployment view: "arc/deployment.md"
      - Crosscutting Concepts: "arc/concepts.md"
      - Architecture Decisions: "arc/decisions.md"
      - Quality Requirements: "arc/quality.md"
      - Risks and Technical Debt: "arc/risks.md"
      - Glossary: "arc/glossary.md"
  - API Reference: reference/

theme:
  name: material
  repo_url: "https://github.com/Paul-B98/python-project-template"
  features:
    - navigation.tabs
    - navigation.footer

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Paul-B98/python-project-template
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ # TODO change this to your project name

extra_css:
  - assets/css/code_select.css
  - assets/css/fonts.css

# Plugins and Extensions
markdown_extensions:
  - attr_list
  - pymdownx.highlight:
      linenums: true
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.extra
  - footnotes
  - pymdownx.arithmatex:
      generic: true

plugins:
  - search:
  - macros:
      include_dir: ./
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: ["project_name"]
          options:
            docstring_style: numpy