python-project-template/mkdocs.yml at main · oqtopus-team/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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
site_name: "Python Project Template"
site_description: "Template repository for building Python projects in OQTOPUS ecosystem"
repo_name: python-project-template
repo_url: "https://github.com/oqtopus-team/python-project-template"

nav:
  - Home: index.md
  - Usage:
      - Getting started: usage/getting_started.md
  - API reference:
      - python-project-template: reference/
  - Developer Guidelines:
      - Development Flow: developer_guidelines/development_flow.md
      - Setup Development Environment: developer_guidelines/setup.md
      - How to Contribute: CONTRIBUTING.md
      - Code of Conduct: "https://github.com/oqtopus-team/.github/blob/main/CODE_OF_CONDUCT.md"
      - Security: "https://github.com/oqtopus-team/.github/blob/main/SECURITY.md"

theme:
  name: material
  palette:
    primary: "indigo"
    accent: "indigo"
  font:
    text: "Roboto"
    code: "Roboto Mono"
  logo: asset/oqtopus-black_symbol.svg
  favicon: asset/favicon.png
  icon:
    repo: fontawesome/brands/github
  features:
    - toc.follow
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - footnotes
  - toc:
      permalink: true

plugins:
  - search
  - gen-files:
      scripts:
        - docs_scripts/gen_ref_nav.py
  - literate-nav:
      nav_file: API_reference.md
  - mkdocstrings:
      #custom_templates: docs/templates
      handlers:
        python:
          paths: [src]
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            preload_modules: [mkdocstrings]
            relative_crossrefs: true
            scoped_crossrefs: true
            separate_signature: true
            show_bases: false
            show_inheritance_diagram: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary:
              modules: false
              classes: true
              functions: true
              attributes: true
            unwrap_annotated: true
  - mkdocs-jupyter

extra_css:
  - "https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"
  - "css/custom.css"