NNS-python/mkdocs.yml at main · OVVO-Financial/NNS-python · 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
site_name: NNS Python
site_description: Nonlinear Nonparametric Statistics for Python — a parity-focused port of R NNS.
site_url: https://ovvo-financial.github.io/NNS-python/
site_author: Fred Viole

repo_name: OVVO-Financial/NNS-python
repo_url: https://github.com/OVVO-Financial/NNS-python
edit_uri: edit/main/docs/

copyright: Developed by Fred Viole.

theme:
  name: material
  # pkgdown's navbar uses a text brand ("NNS") with the hex sticker shown in
  # the home page body, so we keep the header text-only and place the sticker
  # on the home page instead of using it as a header logo.
  favicon: assets/nns_hex_sticker.png
  # Match the R NNS pkgdown site (Bootstrap 5 + Bootswatch "Cosmo"):
  # flat design, a solid blue top navbar, and the Source Sans typeface.
  font:
    text: Source Sans 3
    code: Source Code Pro
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/cosmo.css

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OVVO-Financial/NNS-python
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ovvo-nns/

# Pages that exist in docs/ but are surfaced as sub-pages of the nav below.
# Keep this nav aligned with README "Documentation" links.
nav:
  - Home: index.md
  - Install: install.md
  - Quick start: quick_start.md
  - API reference: api_reference.md
  - API status: api_status.md
  - Conventions:
      - Behavior conventions: conventions.md
      - Plot parity policy: plot_parity_policy.md
  - Parity with R NNS:
      - Parity overview: parity.md
      - Sync contract: sync_contract.md
      - Sync status: sync_status.md
  - Benchmarks: benchmarks.md
  - Release notes:
      - Release notes: release_notes.md
      - Release process: releasing.md