one more round of organization

rmorshea · rmorshea · commit 7983caf04506 · 2021-10-25T23:06:53.000-07:00
diff --git a/docs/source/_autogen/dev-apis.rst b/docs/source/_autogen/dev-apis.rst
@@ -1,4 +1,4 @@
-Developer API
+Dev API
 ==============
 
 .. automodule:: idom._option
diff --git a/docs/source/_exts/autogen_api_docs.py b/docs/source/_exts/autogen_api_docs.py
@@ -13,12 +13,12 @@
 AUTOGEN_DIR.mkdir(exist_ok=True)
 
 PUBLIC_API_REFERENCE_FILE = AUTOGEN_DIR / "user-apis.rst"
-PRIVATE_API_REFERENCE_FILE = AUTOGEN_DIR / "developer-apis.rst"
+PRIVATE_API_REFERENCE_FILE = AUTOGEN_DIR / "dev-apis.rst"
 
 
 PUBLIC_TITLE = "User API\n=============\n"
 PUBLIC_MISC_TITLE = "Misc Modules\n------------\n"
-PRIVATE_TITLE = "Developer API\n==============\n"
+PRIVATE_TITLE = "Dev API\n==============\n"
 PRIVATE_MISC_TITLE = "Misc Dev Modules\n----------------\n"
 
 AUTODOC_TEMPLATE = ".. automodule:: {module}\n    :members:\n"
diff --git a/docs/source/adding-interactivity/index.rst b/docs/source/adding-interactivity/index.rst
@@ -0,0 +1,11 @@
+Adding Interactivity
+====================
+
+.. toctree::
+    :hidden:
+
+    responding-to-events
+    components-with-state
+    state-as-a-snapshot
+    dangers-of-mutability
+    batched-updates
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -65,6 +65,7 @@
     "patched_html_translator",
     "widget_example",
     "build_custom_js",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -89,7 +90,9 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-# exclude_patterns = []
+exclude_patterns = [
+    "_custom_js",
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
diff --git a/docs/source/contributing/changelog.rst b/docs/source/contributing/changelog.rst
diff --git a/docs/source/contributing/developer-guide.rst b/docs/source/contributing/developer-guide.rst
diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst
@@ -1,5 +1,12 @@
-Contributing
-============
+Contributing to IDOM
+====================
+
+.. toctree::
+    :hidden:
+
+    developer-guide
+    changelog
+    roadmap
 
 .. note::
 
diff --git a/docs/source/contributing/roadmap.rst b/docs/source/contributing/roadmap.rst
diff --git a/docs/source/creating-interfaces/index.rst b/docs/source/creating-interfaces/index.rst
@@ -0,0 +1,11 @@
+Creating Interfaces
+===================
+
+.. toctree::
+    :hidden:
+
+    intro-to-html
+    your-first-component
+    parametrizing-components
+    conditional-rendering
+    dynamic-layout-structure
diff --git a/docs/source/escape-hatches/index.rst b/docs/source/escape-hatches/index.rst
@@ -0,0 +1,11 @@
+Escape Hatches
+==============
+
+.. toctree::
+    :hidden:
+
+    class-components
+    javascript-components
+    distributing-javascript
+
+Under construction :)
diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -0,0 +1,9 @@
+Getting Started
+===============
+
+.. toctree::
+    :hidden:
+
+    installation
+    running-idom
+    why-idom
diff --git a/docs/source/getting-started/running-idom.rst b/docs/source/getting-started/running-idom.rst
@@ -5,6 +5,6 @@ Under construction :)
 
 
 Configuring IDOM
-================
+----------------
 
 Under construction :)
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,86 +3,31 @@ IDOM
 
 .. toctree::
     :hidden:
-    :caption: Getting Started
+    :caption: User Guide
 
-    getting-started/installation
-    getting-started/running-idom
+    getting-started/index
+    creating-interfaces/index
+    adding-interactivity/index
+    managing-state/index
+    escape-hatches/index
 
 .. toctree::
     :hidden:
-    :caption: Creating Interfaces
+    :caption: Other Resources
 
-    creating-interfaces/intro-to-html
-    creating-interfaces/your-first-component
-    creating-interfaces/parametrizing-components
-    creating-interfaces/conditional-rendering
-    creating-interfaces/dynamic-layout-structure
+    understanding-idom/index
+    contributing/index
+    reference-material/index
 
 .. toctree::
     :hidden:
-    :caption: Adding Interactivity
-
-    adding-interactivity/responding-to-events
-    adding-interactivity/stateful-components
-    adding-interactivity/state-as-a-snapshot
-    adding-interactivity/dangers-of-mutability
-    adding-interactivity/batched-updates
-
-.. toctree::
-    :hidden:
-    :caption: Managing State
-
-    managing-state/logical-flow-of-state
-    managing-state/structuring-your-state
-    managing-state/shared-component-state
-    managing-state/when-to-reset-state
-
-.. toctree::
-    :hidden:
-    :caption: Escape Hatches
-
-    escape-hatches/class-components
-    escape-hatches/javascript-components
-    escape-hatches/distributing-javascript
-
-
-.. toctree::
-    :hidden:
-    :caption: Understanding IDOM
-
-    understanding-idom/core-abstractions
-
-
-
-.. toctree::
-    :hidden:
-    :caption: References
-
-    references/gallery
-    references/hooks-api
-    _autogen/user-apis
-    references/why-idom
-    references/specifications
-    references/faq
-
-.. toctree::
-    :hidden:
-    :caption: Development
-
-    development/contributing
-    development/developer-guide
-    _autogen/developer-apis
-    development/changelog
-    development/roadmap
-
-.. toctree::
-    :hidden:
-    :caption: Resources
+    :caption: External Links
 
     Source Code <https://github.com/idom-team/idom>
     Community <https://github.com/idom-team/idom/discussions>
     Issues <https://github.com/idom-team/idom/issues>
 
+
 IDOM is a powerful Python web framework for building **interactive websites without
 needing a single line of Javascript**. It does this by breaking down complex
 applications into nestable and reusable chunks of code called "components" that allow
diff --git a/docs/source/managing-state/index.rst b/docs/source/managing-state/index.rst
@@ -0,0 +1,12 @@
+Managing State
+==============
+
+.. toctree::
+    :hidden:
+
+    logical-flow-of-state
+    structuring-your-state
+    shared-component-state
+    when-to-reset-state
+
+Under construction :)
diff --git a/docs/source/reference-material/faq.rst b/docs/source/reference-material/faq.rst
diff --git a/docs/source/reference-material/gallery.rst b/docs/source/reference-material/gallery.rst
diff --git a/docs/source/reference-material/hooks-api.rst b/docs/source/reference-material/hooks-api.rst
@@ -1,6 +1,6 @@
-===================
-Hooks API Reference
-===================
+=========
+Hooks API
+=========
 
 Hooks are functions that allow you to "hook into" the life cycle events and state of
 Components. Their usage should always follow the :ref:`Rules of Hooks`. For most use
diff --git a/docs/source/reference-material/index.rst b/docs/source/reference-material/index.rst
@@ -0,0 +1,12 @@
+Reference Material
+==================
+
+.. toctree::
+    :hidden:
+
+    gallery
+    hooks-api
+    /_autogen/user-apis
+    /_autogen/dev-apis
+    specifications
+    faq
diff --git a/docs/source/reference-material/specifications.rst b/docs/source/reference-material/specifications.rst
diff --git a/docs/source/understanding-idom/index.rst b/docs/source/understanding-idom/index.rst
@@ -0,0 +1,8 @@
+Understanding IDOM
+==================
+
+.. toctree::
+    :hidden:
+
+    why-idom
+    core-abstractions
diff --git a/docs/source/understanding-idom/why-idom.rst b/docs/source/understanding-idom/why-idom.rst
diff --git a/requirements/build-docs.txt b/requirements/build-docs.txt
@@ -6,3 +6,4 @@ sphinx-copybutton ==0.3.0
 sphinx-autobuild ==2020.9.1
 sphinx-reredirects ==0.0.1
 sphinx-design ==0.0.12
+myst-parser ==0.15.2

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Developer API`
	`1`	`+Dev API`
`2`	`2`	`==============`
`3`	`3`
`4`	`4`	`.. automodule:: idom._option`