doc-fun/mkdocs.yml at main · fasrc/doc-fun · 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
site_name: 'doc-generator Documentation'
site_description: 'AI-powered documentation generator with extensible plugin architecture'
site_author: 'FASRC Research Computing'
site_url: 'https://fasrc.github.io/doc-fun'

repo_name: 'fasrc/doc-fun'
repo_url: 'https://github.com/fasrc/doc-fun'
edit_uri: 'edit/main/docs/'

copyright: 'Copyright &copy; 2024 FASRC Research Computing'

theme:
  name: 'material'
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - toc.follow
    - toc.integrate
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.action.edit
    - content.action.view
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

nav:
  - Home: index.md
  - Getting Started:
    - Installation: guides/installation.md
    - First Steps: guides/getting-started.md
    - Configuration: guides/configuration.md
    - Document Standardization: guides/document-standardization.md
    - Documentation Comparison: guides/comparison.md
  - Development:
    - Testing: guides/testing.md
    - Creating Plugins: guides/creating-plugins.md
    - Contributing: guides/contributing.md
    - Quality Optimization: quality-optimization-approaches.md
  - API Reference:
    - Overview: api/index.md
    - Core: api/core.md
    - Extractors: api/extractors.md
    - Standardizers: api/standardizers.md
    - Plugins: api/plugins.md
    - Evaluator: api/evaluator.md
    - CLI: api/cli.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Advanced Workflows: examples/advanced.md
    - Plugin Examples: examples/plugins.md
    - Troubleshooting: examples/troubleshooting.md
  - Design:
    - Overview: design/index.md
    - Claude API Integration: design/claude-api-integration.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: Page contents
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: fasrc
      repo: doc-fun
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_submodules: true
            show_source: true
            show_root_heading: true
            show_root_members_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            group_by_category: true
            heading_level: 1

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fasrc/doc-fun
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/doc-generator/
    - icon: fontawesome/solid/globe
      link: https://www.rc.fas.harvard.edu/

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/mermaid@10.6.0/dist/mermaid.min.js
  - javascripts/mermaid.js