Ignore documentation stubs, add autosummary templates

cbarrick · Jun 6, 2018 · 4e11bef · 4e11bef
1 parent 03e1d34
commit 4e11bef
Show file tree

Hide file tree

Showing 54 changed files with 40 additions and 1,287 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,10 @@
 # data downloaded by datasets
 /data
 
+# Sphinx documentation
+/docs/_build
+/docs/api/stubs
+
 
 # Generic Python ignores
 # --------------------------------------------------

diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
@@ -0,0 +1,6 @@
+{{ fullname }}
+==================================================
+
+.. currentmodule:: {{ module }}
+
+.. autodata:: {{ objname }}
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -0,0 +1,24 @@
+{{ fullname }}
+==================================================
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+
+Member Index
+--------------------------------------------------
+.. rubric:: Methods
+.. autosummary::
+
+	{% for meth in methods %}
+	~{{ objname }}.{{ meth }}
+	{% endfor %}
+
+
+.. rubric:: Attributes
+.. autosummary::
+
+	{% for attr in attributes %}
+	~{{ objname }}.{{ attr }}
+	{% endfor %}
diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst
@@ -0,0 +1,6 @@
+{{ fullname }}
+==================================================
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}
diff --git a/docs/api/stubs/toys.BaseEstimator.rst b/docs/api/stubs/toys.BaseEstimator.rst
diff --git a/docs/api/stubs/toys.Dataset.rst b/docs/api/stubs/toys.Dataset.rst
diff --git a/docs/api/stubs/toys.Estimator.rst b/docs/api/stubs/toys.Estimator.rst
diff --git a/docs/api/stubs/toys.Metric.rst b/docs/api/stubs/toys.Metric.rst
diff --git a/docs/api/stubs/toys.Model.rst b/docs/api/stubs/toys.Model.rst
diff --git a/docs/api/stubs/toys.TorchModel.rst b/docs/api/stubs/toys.TorchModel.rst
diff --git a/docs/api/stubs/toys.TunedEstimator.rst b/docs/api/stubs/toys.TunedEstimator.rst
diff --git a/docs/api/stubs/toys.batches.rst b/docs/api/stubs/toys.batches.rst
diff --git a/docs/api/stubs/toys.concat.rst b/docs/api/stubs/toys.concat.rst
diff --git a/docs/api/stubs/toys.datasets.CIFAR10.rst b/docs/api/stubs/toys.datasets.CIFAR10.rst
diff --git a/docs/api/stubs/toys.datasets.CIFAR100.rst b/docs/api/stubs/toys.datasets.CIFAR100.rst
diff --git a/docs/api/stubs/toys.datasets.CIFAR20.rst b/docs/api/stubs/toys.datasets.CIFAR20.rst
diff --git a/docs/api/stubs/toys.datasets.SimulatedLinear.rst b/docs/api/stubs/toys.datasets.SimulatedLinear.rst