Commit 095e58a2 authored by Daniel Williams's avatar Daniel Williams
Browse files

Added more docs.

parent d4f3f068

Makefile

+4 −4
Original line number Original line Diff line number Diff line
@@ -46,7 +46,7 @@ clean-test: 
	rm -fr htmlcov/

	rm -fr htmlcov/





lint:

lint:

	flake8 minki tests

	flake8 minke tests





test:

test:

	python setup.py test

	python setup.py test
@@ -55,15 +55,15 @@ test-all: 
	tox

	tox





coverage:

coverage:

	coverage run --source minki setup.py test

	coverage run --source minke setup.py test

	coverage report -m

	coverage report -m

	coverage html

	coverage html

	$(BROWSER) htmlcov/index.html

	$(BROWSER) htmlcov/index.html





docs:

docs:

	rm -f docs/minki.rst

	rm -f docs/minke.rst

	rm -f docs/modules.rst

	rm -f docs/modules.rst

	sphinx-apidoc -o docs/ minki

	sphinx-apidoc -o docs/ minke

	$(MAKE) -C docs clean

	$(MAKE) -C docs clean

	$(MAKE) -C docs html

	$(MAKE) -C docs html

	$(BROWSER) docs/_build/html/index.html

	$(BROWSER) docs/_build/html/index.html

README.rst

+6 −1
Original line number Original line Diff line number Diff line
@@ -23,7 +23,12 @@ Minke is a Python package to produce Mock Data Challenge data sets for LIGO inte 
Features

Features

--------

--------





* TODO

* Produces burst MDCs with Gaussian, SineGaussian, and White Noise Burst ad-hoc waveforms

* Produces numerical relativity burst MDCs for supernovae

* Produces GWF frame files for MDCs

* Produces GravEn-format log files for MDCs

* TODO Produces SimBurstTable XML files for MDCs







Credits

Credits

---------

---------

docs/conf.py

+3 −3
Original line number Original line Diff line number Diff line
@@ -31,7 +31,7 @@ project_root = os.path.dirname(cwd) 
# version is used.

# version is used.

sys.path.insert(0, project_root)

sys.path.insert(0, project_root)





import minki

import minke





# Load the bootstrap theme

# Load the bootstrap theme

import sphinx_bootstrap_theme

import sphinx_bootstrap_theme
@@ -65,9 +65,9 @@ copyright = u'2016, Daniel Williams' 
# the built documents.

# the built documents.

#

#

# The short X.Y version.

# The short X.Y version.

version = minki.__version__

version = minke.__version__

# The full version, including alpha/beta/rc tags.

# The full version, including alpha/beta/rc tags.

release = minki.__version__

release = minke.__version__





# The language for content autogenerated by Sphinx. Refer to documentation

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# for a list of supported languages.

docs/minki.rst

deleted100644 → 0
+0 −30
Original line number Original line Diff line number Diff line 
minki package

=============



Submodules

----------



minki.mdctools module

---------------------



.. automodule:: minki.mdctools

    :members:

    :undoc-members:

    :show-inheritance:



minki.minki module

------------------



.. automodule:: minki.minki

    :members:

    :undoc-members:

    :show-inheritance:





Module contents

---------------



.. automodule:: minki

    :members:

    :undoc-members:

    :show-inheritance:

docs/modules.rst

+2 −2
Original line number Original line Diff line number Diff line 
minki

minke

=====

=====





.. toctree::

.. toctree::

   :maxdepth: 4

   :maxdepth: 4





   minki
 
   minke