conjunto/mkdocs.yml at main · nerdocs/conjunto · 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
site_name: Conjunto documentation
repo_url: https://github.com/nerdocs/conjunto
edit_uri: blob/main/docs/
site_description: "Conjunto - Django application framework using Tetra, Tabler.io, tables2, crispy, etc."
site_dir: public

nav:
  - Overview: index.md
  - Usage:
    - Installation: usage/installation.md
    - URLs: usage/urls.md
    - Components: usage/components.md
    - Settings: usage/settings.md
    - Maintenance Mode: usage/maintenance_mode.md
  - Management:
    - Commands: mgmt_cmds.md
  - Development:
      - General advices: development.md
      - Pluggable components: development/pluggable_components.md
      - API: reference/
  - FAQ: faq.md

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [ src ]
          options:
            show_source: false
            show_submodules: true
            show_root_heading: true
            show_root_members_full_path: true
      default_handler: python
  - search
  - autorefs
  - gen-files:
      scripts:
      - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index

theme:
  name: readthedocs
  features:
      - navigation.instant
      - navigation.tabs
hooks:
  - docs/hooks.py
watch:
  - src/conjunto

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - meta
  - toc:
      permalink: True
  # - pymdownx.superfences:
  #     custom_fences:
  #       - name: mermaid
  #         class: mermaid
  #         format: !!python/name:pymdownx.superfences.fence_code_format