Skip to content

Commit d3b8fe7

Browse files
committed
building docs from docstrings
1 parent a3b63db commit d3b8fe7

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

mkdocs.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
site_name: "Plotly.py Docs"
22
docs_dir: pages
33
site_dir: docs
4+
5+
plugins:
6+
- search
7+
- mkdocstrings:
8+
handlers:
9+
python:
10+
options:
11+
docstring_style: google
12+
show_source: false
13+
show_root_heading: true
14+
show_root_toc_entry: true
15+
merge_init_into_class: true
16+
417
nav:
518
- Home: index.md
19+
- API Reference:
20+
- plotly: reference/plotly.md
21+
- plotly.graph_objects: reference/graph_objects.md
22+
- plotly.express: reference/express.md
623
- Project:
724
- license.md
825
- conduct.md

pages/reference/express.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Plotly Express
2+
3+
::: plotly.express

pages/reference/graph_objects.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Graph Objects
2+
3+
::: plotly.graph_objects

pages/reference/plotly.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Plotly API Reference
2+
3+
::: plotly

0 commit comments

Comments
 (0)