django-security-label/mkdocs.yml at main · tim-schilling/django-security-label · 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
site_name: Django Security Label
site_description: Django support for PostgreSQL security labels, including anonymizing/masking data.
repo_url: https://github.com/tim-schilling/django-security-label

theme:
  name: material
  features:
    - content.code.copy

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          options:
            show_source: false
            inherited_members: false
            members_order: source
            show_if_no_docstring: true
            merge_init_into_class: true
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

nav:
  - Home: index.md
  - Installation: installation.md
  - Tutorials:
      - Running the Example App: tutorials/run-the-example.md
  - How-To Guides:
      - Customizing Masked Reads: how-to-guides/customizing-masked-reads.md
      - Masking Functions: how-to-guides/masking-functions.md
      - Setting Up Group-Based Masking: how-to-guides/group-based-masking.md
  - Reference: reference/
  - Explanation:
      - Overview: explanation/overview.md
      - How Dynamic Masking Works: explanation/how-dynamic-masking-works.md
  - Contributing: contribute.md