docs: Move elements to API reference documentation

kylef · kylef · commit 3e71a3825169 · 2018-04-09T16:10:58.000-07:00
Include public API and elements via autoclass
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,173 @@
+API Reference
+=============
+
+.. contents::
+   :depth: 4
+
+Namespace
+---------
+
+.. autoclass:: Namespace
+    :members:
+
+Serialiser
+~~~~~~~~~~
+
+.. autoclass:: JSONSerialiser
+    :members:
+
+Elements
+--------
+
+Element
+~~~~~~~
+
+.. autoclass:: Element
+   :members:
+
+Primitives
+~~~~~~~~~~
+
+String
+^^^^^^
+
+.. autoclass:: StringElement
+   :members:
+
+Number
+^^^^^^
+
+.. autoclass:: NumberElement
+   :members:
+
+Boolean
+^^^^^^^
+
+.. autoclass:: BooleanElement
+   :members:
+
+Null
+^^^^
+
+.. autoclass:: NullElement
+   :members:
+
+Collections
+~~~~~~~~~~~
+
+Array
+^^^^^
+
+.. autoclass:: ArrayElement
+   :members:
+
+Object
+^^^^^^
+
+.. autoclass:: ObjectElement
+   :members:
+
+Member
+^^^^^^
+
+.. autoclass:: MemberElement
+   :members:
+
+Profiles
+~~~~~~~~
+
+.. autoclass:: LinkElement
+   :members:
+
+Referencing
+~~~~~~~~~~~
+
+.. autoclass:: RefElement
+   :members:
+
+Parse Result
+~~~~~~~~~~~~
+
+.. autoclass:: ParseResult
+   :members:
+
+Annotation
+^^^^^^^^^^
+
+.. autoclass:: Annotation
+   :members:
+
+SourceMap
+^^^^^^^^^
+
+.. autoclass:: SourceMap
+   :members:
+
+API Description
+~~~~~~~~~~~~~~~
+
+Category
+^^^^^^^^
+
+.. autoclass:: Category
+    :members:
+
+Copy
+^^^^
+
+.. autoclass:: Copy
+    :members:
+
+Data Structure
+^^^^^^^^^^^^^^
+
+.. autoclass:: DataStructure
+    :members:
+
+.. autoclass:: Enum
+    :members:
+
+Resource
+^^^^^^^^
+
+.. autoclass:: Resource
+    :members:
+
+.. autoclass:: Transition
+    :members:
+
+HTTP Transaction
+^^^^^^^^^^^^^^^^
+
+.. autoclass:: HttpTransaction
+    :members:
+
+.. autoclass:: HttpMessagePayload
+    :members:
+
+.. autoclass:: HttpRequest
+    :members:
+
+.. autoclass:: HttpResponse
+    :members:
+
+.. autoclass:: HttpHeaders
+    :members:
+
+.. autoclass:: Asset
+    :members:
+
+.. autoclass:: HrefVariables
+    :members:
+
+.. autoclass:: AuthScheme
+    :members:
+
+Slice
+-----
+
+.. autoclass:: ArraySlice
+    :members:
+
+.. autoclass:: ObjectSlice
+    :members:
diff --git a/docs/conf.json b/docs/conf.json
@@ -1,8 +1,10 @@
 {
   "source": {
     "include": [
+      "../node_modules/minim/lib",
       "../node_modules/minim/lib/primitives",
       "../node_modules/minim/lib/elements",
+      "../node_modules/minim/lib/serialisers",
       "../node_modules/minim-api-description/lib/elements",
       "../node_modules/minim-parse-result/lib"
     ]
diff --git a/docs/elements.rst b/docs/elements.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -34,9 +34,9 @@ API Reference
 -------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
-   elements
+   api
 
 Indices and tables
 ==================

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"source": {`
`3`	`3`	`"include": [`
	`4`	`+ "../node_modules/minim/lib",`
`4`	`5`	`"../node_modules/minim/lib/primitives",`
`5`	`6`	`"../node_modules/minim/lib/elements",`
	`7`	`+ "../node_modules/minim/lib/serialisers",`
`6`	`8`	`"../node_modules/minim-api-description/lib/elements",`
`7`	`9`	`"../node_modules/minim-parse-result/lib"`
`8`	`10`	`]`