Changes to make local docs generation to work with poetry

mgalloy · May 4, 2019 · 085308d · 085308d
1 parent 3afa367
commit 085308d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/Makefile b/Makefile
@@ -71,7 +71,7 @@ coverage: ## check code coverage quickly with the default Python
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/epochs.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ epochs
+	poetry run sphinx-apidoc -o docs/ epochs
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

diff --git a/docs/Makefile b/docs/Makefile
@@ -17,4 +17,4 @@ 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
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@poetry run $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/epochs.rst b/docs/epochs.rst
@@ -4,10 +4,10 @@ epochs package
 Submodules
 ----------
 
-epochs\.parser module
----------------------
+epochs.configparser module
+--------------------------
 
-.. automodule:: epochs.parser
+.. automodule:: epochs.configparser
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/pyproject.toml b/pyproject.toml
@@ -29,6 +29,7 @@ coverage = "^4.5"
 flake8 = "^3.7"
 pytest-runner = "^4.4"
 black = { version = "*", allows-prereleases = true }
+sphinx_rtd_theme = "^0.4.3"
 
 [tool.black]
 line-length = 88