Safe-Synthesizer/mkdocs.yml at main · NVIDIA-NeMo/Safe-Synthesizer · 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: NeMo Safe Synthesizer
site_url: https://nvidia-nemo.github.io/Safe-Synthesizer/
site_description: Generate synthetic data with privacy guarantees
repo_url: https://github.com/NVIDIA-NeMo/Safe-Synthesizer
repo_name: NVIDIA-NeMo/Safe-Synthesizer
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2024-2026 NVIDIA CORPORATION & AFFILIATES

theme:
  name: material
  custom_dir: docs/overrides
  font:
    text: Roboto
    code: Fira Code
  icon:
    logo: fontawesome/solid/shield
    repo: fontawesome/brands/github
  favicon: assets/shield-favicon.svg
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - search.suggest
    - search.highlight
    - toc.follow

extra_css:
  - css/style.css
  - css/mkdocstrings.css

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

watch:
  - src/nemo_safe_synthesizer
  - docs/

strict: !ENV [MKDOCS_STRICT, false]

hooks:
  - docs/hooks.py

plugins:
  - search
  - blog:
      blog_dir: blog
      blog_toc: true
      post_date_format: long
      post_url_format: "{slug}"
      categories: false
      archive: true
      archive_toc: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: table
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            allow_inspection: false
            show_if_no_docstring: false
            summary: true
            filters: ["!^_"]
            extensions:
              - griffe_pydantic:
                  schema: false
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocs-jupyter:
      include_source: true
      include_requirejs: true
      ignore_h1_titles: true
      execute: false
      ignore:
        - "docs/gen_ref_pages.py"

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path:
        - docs/
        - .
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - tables

nav:
  - Home: index.md
  - Product Overview:
      - Pipeline: product-overview/pipeline.md
      - Data Synthesis: product-overview/data_synthesis.md
      - PII Replacement: product-overview/pii_replacement.md
      - Evaluation: product-overview/evaluation.md
  - Tutorials:
      - tutorials/index.md
      - Safe Synthesizer 101: tutorials/safe-synthesizer-101.ipynb
      - Differential Privacy: tutorials/differential-privacy.ipynb
  - User Guide:
      - Getting Started: user-guide/getting-started.md
      - Running Safe Synthesizer: user-guide/running.md
      - Docker: user-guide/docker.md
      - Troubleshooting:
          - Synthetic Data Quality: user-guide/evaluating-data.md
          - Program Runtime: user-guide/troubleshooting.md
      - Reference:
          - Configuration: user-guide/configuration.md
          - Environment Variables: user-guide/environment.md
  - Developer Guide:
      - Architecture: developer-guide/architecture.md
      - Example Generation: developer-guide/example-generation.md
      - Docker: developer-guide/docker.md
      - API Reference: reference/
  - Developer Notes:
      - blog/index.md