From b1a2702d5442a77b45c8cecc5d6cb26ad2b3c660 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 19 Nov 2012 04:02:17 -0500 Subject: [PATCH] README: document Sphinx build invocation --- README | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README b/README index 3774571..ce1c944 100644 --- a/README +++ b/README @@ -4,7 +4,6 @@ This package wraps NumPy's fft module to produce unitary transforms and power spectra of real numbers in one dimension. See the code for the technical details. - Installation ============ @@ -21,7 +20,6 @@ overlay`_. Install with:: # layman --add wtk # emerge -av dev-python/FFT-tools - Dependencies ------------ @@ -34,7 +32,6 @@ Package Debian_ Gentoo_ NumPy_ python-numpy dev-python/numpy ======= ============ ================ - Installing by hand ------------------ @@ -47,13 +44,22 @@ standard:: $ python setup.py install +Building the HTML docs +---------------------- + +The module objects are documented in the `NumPy/SciPy documentation +style`_. You should be able to build this documentation with Sphinx_ +and the numpydoc_ extension. I haven't been able to get numpydoc +working cleanly, but you can still build a decent version of the docs +from the ``doc`` subdirectory with:: + + $ PYTHONPATH=.. make SPHINXBUILD=sphinx-build-2.7 dirhtml Usage ===== See the tests in ``FFT_tools.py`` for simple examples. - Testing ======= @@ -66,7 +72,6 @@ need to install matplotlib_. Then run:: $ python -m FFT_tools --plot - Licence ======= @@ -82,4 +87,8 @@ Version 3`_ or greater. .. _Git: http://git-scm.com/ .. _homepage: http://blog.tremily.us/posts/FFT-tools/ .. _matplotlib: http://matplotlib.sourceforge.net/ +.. _NumPy/SciPy documentation style: + https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt +.. _Sphinx: http://sphinx-doc.org/ +.. _numpydoc: https://github.com/numpy/numpy/tree/master/doc/sphinxext .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt -- 2.26.2