API docs

README.md

@@ -0,0 +1,10 @@
+# sharrow
+numba for ActivitySim-style spec files
+
+## Building the documentation
+
+Building the documentation for sharrow requires JupyterBook.
+
+```shell
+jupyterbook build docs
+```

docs/_config.yml

@@ -4,6 +4,7 @@
 title: sharrow documentation
 author: Cambridge Systematics, Inc.
 logo: logo.png
+copyright: "2022"  # Copyright year to be placed in the footer
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
@@ -26,3 +27,11 @@ repository:
 html:
   use_issues_button: true
   use_repository_button: true
+
+sphinx:
+  extra_extensions:
+  - 'sphinx.ext.autodoc'
+  - 'sphinx.ext.napoleon'
+  - 'sphinx.ext.viewcode'
+  config:
+    add_module_names: False

docs/_toc.yml

@@ -5,3 +5,4 @@ format: jb-book
 root: intro
 chapters:
 - file: walkthrough
+- file: api

docs/api.rst

@@ -0,0 +1,73 @@
+API Reference
+=============
+
+--------------------------------------------------------------------------------
+DataTree
+--------------------------------------------------------------------------------
+.. autoclass:: sharrow.DataTree
+
+Attributes
+~~~~~~~~~~
+.. autoattribute:: sharrow.DataTree.root_node_name
+.. autoattribute:: sharrow.DataTree.subspaces
+.. autoattribute:: sharrow.DataTree.relationships_are_digitized
+
+setup_flow
+~~~~~~~~~~
+.. automethod:: sharrow.DataTree.setup_flow
+
+datasets
+~~~~~~~~
+.. automethod:: sharrow.DataTree.add_dataset
+.. automethod:: sharrow.DataTree.add_relationship
+.. automethod:: sharrow.DataTree.replace_datasets
+
+digitization
+~~~~~~~~~~~~
+.. automethod:: sharrow.DataTree.digitize_relationships
+
+
+
+--------------------------------------------------------------------------------
+Relationship
+--------------------------------------------------------------------------------
+.. autoclass:: sharrow.Relationship
+
+Attributes
+~~~~~~~~~~
+.. autoattribute:: sharrow.Relationship.parent_data
+.. autoattribute:: sharrow.Relationship.parent_name
+.. autoattribute:: sharrow.Relationship.child_data
+.. autoattribute:: sharrow.Relationship.child_name
+.. autoattribute:: sharrow.Relationship.indexing
+.. autoattribute:: sharrow.Relationship.analog
+
+
+
+--------------------------------------------------------------------------------
+Flow
+--------------------------------------------------------------------------------
+.. autoclass:: sharrow.Flow
+
+load
+~~~~
+.. automethod:: sharrow.Flow.load
+.. automethod:: sharrow.Flow.load_dataframe
+.. automethod:: sharrow.Flow.load_dataarray
+
+dot
+~~~
+.. automethod:: sharrow.Flow.dot
+.. automethod:: sharrow.Flow.dot_dataarray
+
+mnl_draws
+~~~~~~~~~
+.. automethod:: sharrow.Flow.mnl_draws
+
+
+
+
+--------------------------------------------------------------------------------
+Dataset
+--------------------------------------------------------------------------------
+.. autoclass:: sharrow.Dataset