civic-data-boundaries-us-cd118/mkdocs.yml at main · civic-interconnect/civic-data-boundaries-us-cd118 · 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
# mkdocs.yml
# Configuration file for MkDocs (Automated project documentation generator)

site_name: civic-data-boundaries-us-cd118 Documentation
site_url: https://civic-interconnect.github.io/civic-data-boundaries-us-cd118/
repo_url: https://github.com/civic-interconnect/civic-data-boundaries-us-cd118
site_description: Documentation for civic-data-boundaries-us-cd118
site_author: Civic Interconnect
docs_dir: docs
site_dir: site

extra:
  version:
    provider: mike

theme:
  name: material
  features:
    - navigation.expand
    - navigation.sections # Group navigation items
    - navigation.top # Back-to-top button
    - search.suggest # Search suggestions as you type
    - search.highlight # Highlight search terms
    - content.code.copy # Copy button on code blocks
    - toc.follow # Highlight current section in TOC
  palette:
    - scheme: default # Light/dark mode toggle
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true # Include module names
            show_root_toc_entry: true # Include module in TOC
            docstring_style: google # Professional docstring format
            show_signature_annotations: true
            separate_signature: true    # Makes function signatures easier to read

markdown_extensions:
  - admonition # Note/Warning/Tip boxes
  - codehilite # Syntax highlighting
  - tables # Markdown tables
  - toc:
      permalink: true # Clickable headers
      toc_depth: 3
  - pymdownx.superfences # Code blocks with syntax highlighting
  - pymdownx.details # Collapsible sections

nav:
- Home: index.md
- API Reference:
  - Civic Data Boundaries Us.Build Index: api/civic_data_boundaries_us.build_index.md
  - Civic Data Boundaries Us.Cd118 Config: api/civic_data_boundaries_us.cd118_config.md
  - Civic Data Boundaries Us.Cleanup: api/civic_data_boundaries_us.cleanup.md
  - Civic Data Boundaries Us.Cli.Build: api/civic_data_boundaries_us.cli.build.md
  - Civic Data Boundaries Us.Cli.Cli: api/civic_data_boundaries_us.cli.cli.md
  - Civic Data Boundaries Us.Cli.Dev: api/civic_data_boundaries_us.cli.dev.md
  - Civic Data Boundaries Us.Cli.Release: api/civic_data_boundaries_us.cli.release.md
  - Civic Data Boundaries Us.Config.Tiger Layers Config: api/civic_data_boundaries_us.config.tiger_layers_config.md
  - Civic Data Boundaries Us.Export: api/civic_data_boundaries_us.export.md
  - Civic Data Boundaries Us.Export Cd118: api/civic_data_boundaries_us.export_cd118.md
  - Civic Data Boundaries Us.Export State: api/civic_data_boundaries_us.export_state.md
  - Civic Data Boundaries Us.Fetch: api/civic_data_boundaries_us.fetch.md
  - Civic Data Boundaries Us.Get Paths: api/civic_data_boundaries_us.get_paths.md
  - Civic Data Boundaries Us.Index: api/civic_data_boundaries_us.index.md
  - Civic Data Boundaries Us.Utils.Get Paths: api/civic_data_boundaries_us.utils.get_paths.md
  - Civic Data Boundaries Us.Utils.Tiger Config: api/civic_data_boundaries_us.utils.tiger_config.md
  - Civic Data Boundaries Us.Utils.Tiger Utils: api/civic_data_boundaries_us.utils.tiger_utils.md
  - Civic Data Boundaries Us Cd118.Cleanup: api/civic_data_boundaries_us_cd118.cleanup.md
  - Civic Data Boundaries Us Cd118.Cli.Cli: api/civic_data_boundaries_us_cd118.cli.cli.md
  - Civic Data Boundaries Us Cd118.Export: api/civic_data_boundaries_us_cd118.export.md
  - Civic Data Boundaries Us Cd118.Export Cd118: api/civic_data_boundaries_us_cd118.export_cd118.md
  - Civic Data Boundaries Us Cd118.Fetch: api/civic_data_boundaries_us_cd118.fetch.md
  - Civic Data Boundaries Us Cd118.Index: api/civic_data_boundaries_us_cd118.index.md
  - Civic Data Boundaries Us Cd118.Utils.Config Utils: api/civic_data_boundaries_us_cd118.utils.config_utils.md
  - Civic Data Boundaries Us Cd118.Utils.Get Paths: api/civic_data_boundaries_us_cd118.utils.get_paths.md