Regenerate API Documentation

Author: Onoyiza

docs/sphinx/source/_static/pydata-custom.css

@@ -0,0 +1,10 @@
+/*Tweaks to the Pydata default CSS */
+
+/*No yellow background highlight when targeted by summary tables */
+/*dt:target { background-color: #f8f8f8; border: 1px solid black, }*/
+dt:target { background: transparent;}
+/*More space between H1s and signatures in API reference*/
+h1 { margin-bottom: 40px; }
+
+/*No line underneath summary table headings (clashes with line above first member)*/
+p.rubric { border-bottom: 0px; }

docs/sphinx/source/_static/rtd-custom.css

@@ -0,0 +1,35 @@
+/* Override nav bar color */
+/*.wy-side-nav-search {
+    background-color: #fbfbb6;
+}
+.wy-side-nav-search > a {
+    color: #b2355c
+}*/
+
+/* Override text bar color */
+/*.caption-text {
+    color: #b2355c;
+}*/
+
+/* Override code signature colour */
+/*.rst-content dl:not(.docutils) dt {
+    background: #fbfbb6;
+    color: #b2355c;
+    border-top: solid 3px #b2355c;
+}*/
+
+/* Override hyperlink colour */
+/* a {
+    color: #b2355c;
+}*/
+
+/* Make content width wider*/
+.wy-nav-content {
+    max-width: 75% !important;
+}
+
+/* Word-wrap tables */
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+  white-space: normal;
+}

docs/sphinx/source/_templates/custom-class-template.rst

@@ -0,0 +1,23 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :special-members: __call__, __add__, __mul__
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      {%- if not item.startswith('_') %}
+        {%- if item not in inherited_members %}
+            ~{{ name }}.{{ item }}
+        {%- endif -%}
+      {%- endif -%}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/sphinx/source/_templates/custom-module-template.rst

@@ -0,0 +1,67 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {%- if not item.startswith('_') %}
+        {{ item }}
+      {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/sphinx/source/api/_autosummary/modelspec.base_types.Base.rst

@@ -0,0 +1,36 @@
+modelspec.base\_types.Base
+==========================
+
+.. currentmodule:: modelspec.base_types
+
+.. autoclass:: Base
+   :members:
+   :show-inheritance:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+            ~Base.from_bson
+            ~Base.from_bson_file
+            ~Base.from_dict
+            ~Base.from_file
+            ~Base.from_json
+            ~Base.from_json_file
+            ~Base.from_xml
+            ~Base.from_xml_file
+            ~Base.from_yaml_file
+            ~Base.generate_documentation
+            ~Base.get_child
+            ~Base.to_bson
+            ~Base.to_bson_file
+            ~Base.to_dict
+            ~Base.to_json
+            ~Base.to_json_file
+            ~Base.to_xml
+            ~Base.to_xml_file
+            ~Base.to_yaml
+            ~Base.to_yaml_file

docs/sphinx/source/api/_autosummary/modelspec.base_types.EvaluableExpression.rst

@@ -0,0 +1,15 @@
+modelspec.base\_types.EvaluableExpression
+=========================================
+
+.. currentmodule:: modelspec.base_types
+
+.. autoclass:: EvaluableExpression
+   :members:
+   :show-inheritance:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::

docs/sphinx/source/api/_autosummary/modelspec.base_types.print_.rst

@@ -0,0 +1,6 @@
+modelspec.base\_types.print\_
+=============================
+
+.. currentmodule:: modelspec.base_types
+
+.. autofunction:: print_

docs/sphinx/source/api/_autosummary/modelspec.base_types.print_v.rst

@@ -0,0 +1,6 @@
+modelspec.base\_types.print\_v
+==============================
+
+.. currentmodule:: modelspec.base_types
+
+.. autofunction:: print_v

docs/sphinx/source/api/_autosummary/modelspec.base_types.rst

@@ -0,0 +1,34 @@
+modelspec.base\_types
+=====================
+
+.. automodule:: modelspec.base_types
+
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+
+        print_
+
+        print_v
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      Base
+      EvaluableExpression

docs/sphinx/source/api/_autosummary/modelspec.rst

@@ -0,0 +1,31 @@
+modelspec
+=========
+
+.. automodule:: modelspec
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+
+   modelspec.base_types
+   modelspec.utils