pypums/mkdocs.yml at main · chekos/pypums · 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
site_name: PyPUMS
site_description: Python interface to the US Census Bureau API
site_url: https://pypums.readthedocs.io
repo_url: https://github.com/chekos/pypums
repo_name: chekos/pypums

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - scheme: default
      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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - "Census 101: Which Dataset?": getting-started/census-101.md
  - Guides:
    - ACS Data: guides/acs-data.md
    - Decennial Census: guides/decennial-data.md
    - PUMS Microdata: guides/pums-microdata.md
    - Population Estimates: guides/population-estimates.md
    - Migration Flows: guides/migration-flows.md
    - Finding Variables: guides/variables.md
    - Geography & FIPS Codes: guides/geography.md
    - Margins of Error: guides/margins-of-error.md
    - Spatial Data & Mapping: guides/spatial.md
    - Survey Design & Weights: guides/survey-design.md
    - Caching: guides/caching.md
    - Multi-Year Analysis: guides/multi-year.md
  - Reference:
    - API Reference: reference/api.md
    - CLI Reference: reference/cli.md
    - Datasets: reference/datasets.md
    - Changelog: reference/changelog.md
  - Migration:
    - From tidycensus (R): migration/from-tidycensus.md
    - From Old PyPUMS: migration/from-old-pypums.md
    - From Census FTP: migration/from-census-ftp.md
  - About:
    - Contributing: about/contributing.md
    - Authors: about/authors.md

plugins:
  - search
  - autorefs
  - markdown-exec
  - charts
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            docstring_style: numpy
            merge_init_into_class: true

extra_javascript:
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6

markdown_extensions:
  - smarty
  - toc:
      permalink: true
  - sane_lists
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format ''
        - name: vegalite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - mkdocs-typer