Commit 2cc381c7 authored by David A.. Werner's avatar David A.. Werner
Browse files

Added support for auto-generating documentation using Sphinx

parent 23cabcf4
......@@ -7,3 +7,16 @@ develop:
.PHONY: test
test:
python setup.py test
.PHONY: setup_docs
setup_docs:
sphinx-apidoc -f -M -F -o docs/ manduca/
.PHONY: docs docs_html
docs: docs_html docs_pdf
docs_html: setup_docs
python setup.py build_sphinx
.PHONY: docs_pdf
docs_pdf: setup_docs
python setup.py build_sphinx -b latex
make -C docs/_build/latex/
......@@ -2,3 +2,6 @@
test=pytest
[tool:pytest]
python_files = tests/*.py
[build_sphinx]
source-dir = docs
build-dir = docs/_build
......@@ -8,6 +8,6 @@ setup(name='manduca',
packages=['manduca'],
setup_requires=['pytest-runner'],
tests_require=['pytest'],
install_requires=['Sphinx', 'numpy', 'scipy', 'tqdm'],
install_requires=['Sphinx', 'numpy', 'scipy', 'tqdm', 'matplotlib'],
zip_safe=False)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment