Skip to content

Commit ac90cbb

Browse files
committed
reorganize docs
1 parent a0c3740 commit ac90cbb

23 files changed

+108
-129
lines changed

docs/source/_exts/autogen_api_docs.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@
99
HERE = Path(__file__).parent
1010
PACKAGE_SRC = HERE.parent.parent.parent / "src"
1111

12-
AUTO_DIR = HERE.parent / "auto"
13-
AUTO_DIR.mkdir(exist_ok=True)
12+
REFERENCES_DIR = HERE.parent / "references"
13+
REFERENCES_DIR.mkdir(exist_ok=True)
1414

15-
PUBLIC_API_REFERENCE_FILE = AUTO_DIR / "api-reference.rst"
16-
PRIVATE_API_REFERENCE_FILE = AUTO_DIR / "developer-apis.rst"
15+
PUBLIC_API_REFERENCE_FILE = REFERENCES_DIR / "user-apis.rst"
16+
PRIVATE_API_REFERENCE_FILE = REFERENCES_DIR / "developer-apis.rst"
1717

1818

19-
PUBLIC_TITLE = "API Reference\n=============\n"
19+
PUBLIC_TITLE = "User API\n=============\n"
2020
PUBLIC_MISC_TITLE = "Misc Modules\n------------\n"
21-
PRIVATE_TITLE = "Developer APIs\n==============\n"
21+
PRIVATE_TITLE = "Developer API\n==============\n"
2222
PRIVATE_MISC_TITLE = "Misc Dev Modules\n----------------\n"
2323

2424
AUTODOC_TEMPLATE = ".. automodule:: {module}\n :members:\n"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/source/examples.rst

Lines changed: 0 additions & 98 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Basic Dashboard
2+
---------------
3+
4+
Try interacting with the sliders 📈
5+
6+
.. example:: simple_dashboard
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Making a Game
2+
=============
3+
4+
Click to start playing and use the arrow keys to move 🎮
5+
6+
Slow internet may cause inconsistent frame pacing 😅
7+
8+
.. example:: snake_game
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Matplotlib Plot
2+
===============
3+
4+
Pick the polynomial coefficients (separate each coefficient by a space) 🔢:
5+
6+
.. example:: matplotlib_plot

docs/source/getting-started.rst renamed to docs/source/guides/simple-examples.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
Getting Started
1+
Simple Examples
22
===============
33

4+
Simple Slideshow
5+
----------------
6+
47
Let's break down the following example:
58

69
.. example:: slideshow
@@ -93,3 +96,16 @@ WebSocket. To display the layout we can navigate to http://localhost:8765/client
9396
.. _VDOM mimetype specification: https://github.com/nteract/vdom/blob/master/docs/mimetype-spec.md
9497
.. _ReactJS: https://reactjs.org/docs/faq-internals.html
9598
.. _React Hooks: https://reactjs.org/docs/hooks-overview.html
99+
100+
101+
Click Counter
102+
-------------
103+
104+
.. example:: click_count
105+
106+
To Do List
107+
==========
108+
109+
Try typing in the text box and pressing 'Enter' 📋
110+
111+
.. example:: todo

0 commit comments

Comments
 (0)