Remove docs/source, adding apidoc to docs/Makefile

whisk-ml · May 13, 2020 · 9e1459a · 9e1459a
1 parent 9e43775
commit 9e1459a
Show file tree

Hide file tree

Showing 15 changed files with 9 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -64,8 +64,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/source/modules.rst
-docs/source/whisk*
+docs/modules.rst
+docs/whisk*
 
 # PyBuilder
 target/

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs/conf.py
 
 # Optionally set the version of Python and requirements required to build your docs
 python:

diff --git a/Makefile b/Makefile
@@ -65,7 +65,7 @@ coverage: ## check code coverage quickly with the default Python
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/whisk.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/source/ whisk
+	sphinx-apidoc -o docs/ whisk
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = whisk
-SOURCEDIR     = source/
+SOURCEDIR     = .
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
@@ -17,4 +17,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	sphinx-apidoc -o $(SOURCEDIR) ../$(SPHINXPROJ)
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst
diff --git a/docs/history.rst b/docs/history.rst
@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/installation.rst → docs/installation.rst b/docs/source/installation.rst → docs/installation.rst
diff --git a/docs/source/make.bat → docs/make.bat b/docs/source/make.bat → docs/make.bat
diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1 @@
+.. include:: ../README.md
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
diff --git a/docs/source/history.rst b/docs/source/history.rst
diff --git a/docs/source/readme.md b/docs/source/readme.md
diff --git a/docs/source/usage.rst → docs/usage.rst b/docs/source/usage.rst → docs/usage.rst