Adding auto-generated files to version control

Turns out what I was going for isn't supported officially. There's a partial work around here (readthedocs/readthedocs.org#1139), but I haven't been able to get it working
brahmlower · May 24, 2016 · 4e837ac · 4e837ac
1 parent 3c84e1b
commit 4e837ac
Show file tree

Hide file tree

Showing 8 changed files with 186 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,4 @@
 .DS_Store
 db.sqlite3
 docs/build/
-docs/source/autodoc
 WebInterface/WebInterface/static/adminlte/*
diff --git a/docs/Makefile b/docs/Makefile
@@ -51,8 +51,8 @@ help:
 
 .PHONY: clean
 clean:
-	rm -rf $(BUILDDIR)/*
-	rm -rf $(AUTODOCDIR)/*
+	rm -rf $(BUILDDIR)/
+	rm -rf $(AUTODOCDIR)/
 
 .PHONY: html
 html:

diff --git a/docs/source/autodoc/cssefclient/cssefclient.rst b/docs/source/autodoc/cssefclient/cssefclient.rst
@@ -0,0 +1,38 @@
+cssefclient package
+===================
+
+Submodules
+----------
+
+cssefclient.errors module
+-------------------------
+
+.. automodule:: cssefclient.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefclient.tasks module
+------------------------
+
+.. automodule:: cssefclient.tasks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefclient.utils module
+------------------------
+
+.. automodule:: cssefclient.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cssefclient
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/autodoc/cssefclient/modules.rst b/docs/source/autodoc/cssefclient/modules.rst
@@ -0,0 +1,7 @@
+cssefclient
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   cssefclient
diff --git a/docs/source/autodoc/cssefserver/cssefserver.account.rst b/docs/source/autodoc/cssefserver/cssefserver.account.rst
@@ -0,0 +1,54 @@
+cssefserver.account package
+===========================
+
+Submodules
+----------
+
+cssefserver.account.api module
+------------------------------
+
+.. automodule:: cssefserver.account.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.account.errors module
+---------------------------------
+
+.. automodule:: cssefserver.account.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.account.models module
+---------------------------------
+
+.. automodule:: cssefserver.account.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.account.tasks module
+--------------------------------
+
+.. automodule:: cssefserver.account.tasks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.account.utils module
+--------------------------------
+
+.. automodule:: cssefserver.account.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cssefserver.account
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/autodoc/cssefserver/cssefserver.rst b/docs/source/autodoc/cssefserver/cssefserver.rst
@@ -0,0 +1,77 @@
+cssefserver package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    cssefserver.account
+
+Submodules
+----------
+
+cssefserver.daemon module
+-------------------------
+
+.. automodule:: cssefserver.daemon
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.errors module
+-------------------------
+
+.. automodule:: cssefserver.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.modelbase module
+----------------------------
+
+.. automodule:: cssefserver.modelbase
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.modelutils module
+-----------------------------
+
+.. automodule:: cssefserver.modelutils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.tasks module
+------------------------
+
+.. automodule:: cssefserver.tasks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.taskutils module
+----------------------------
+
+.. automodule:: cssefserver.taskutils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cssefserver.utils module
+------------------------
+
+.. automodule:: cssefserver.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: cssefserver
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/autodoc/cssefserver/modules.rst b/docs/source/autodoc/cssefserver/modules.rst
@@ -0,0 +1,7 @@
+cssefserver
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   cssefserver
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -290,4 +290,4 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-autodoc_member_order = 'bysource'
+autodoc_member_order = 'bysource'