Skip to content

Commit 02ca719

Browse files
add missing files for mkdocs, fix newline error for flake8
1 parent 1070198 commit 02ca719

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

mkdocs.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
site_name: OSHConnect-Python
2+
site_description: Python library for the OGC API – Connected Systems (Parts 1, 2, and 3 Pub/Sub)
3+
site_author: Ian Patterson
4+
repo_url: https://github.com/Botts-Innovative-Research/OSHConnect-Python
5+
edit_uri: ""
6+
7+
docs_dir: docs/markdown
8+
site_dir: docs/build/html
9+
10+
theme:
11+
name: material
12+
features:
13+
- navigation.sections
14+
- navigation.expand
15+
- navigation.top
16+
- content.code.copy
17+
- toc.follow
18+
palette:
19+
- media: "(prefers-color-scheme: light)"
20+
scheme: default
21+
primary: indigo
22+
accent: indigo
23+
toggle:
24+
icon: material/brightness-7
25+
name: Switch to dark mode
26+
- media: "(prefers-color-scheme: dark)"
27+
scheme: slate
28+
primary: indigo
29+
accent: indigo
30+
toggle:
31+
icon: material/brightness-4
32+
name: Switch to light mode
33+
34+
plugins:
35+
- search
36+
- mkdocstrings:
37+
default_handler: python
38+
handlers:
39+
python:
40+
paths: [src]
41+
options:
42+
show_root_heading: true
43+
show_source: false
44+
show_signature_annotations: true
45+
separate_signature: true
46+
docstring_style: sphinx
47+
members_order: source
48+
filters: ["!^_"]
49+
merge_init_into_class: true
50+
51+
markdown_extensions:
52+
- admonition
53+
- attr_list
54+
- md_in_html
55+
- toc:
56+
permalink: true
57+
- pymdownx.highlight:
58+
anchor_linenums: true
59+
- pymdownx.inlinehilite
60+
- pymdownx.snippets
61+
- pymdownx.superfences:
62+
custom_fences:
63+
- name: mermaid
64+
class: mermaid
65+
format: !!python/name:pymdownx.superfences.fence_code_format
66+
67+
nav:
68+
- Home: index.md
69+
- Architecture: architecture.md
70+
- Tutorial: tutorial.md
71+
- API Reference: api.md

0 commit comments

Comments
 (0)