doc: add Sphinx framework for building docs
authorW. Trevor King <wking@tremily.us>
Mon, 19 Nov 2012 08:47:45 +0000 (03:47 -0500)
committerW. Trevor King <wking@tremily.us>
Mon, 19 Nov 2012 08:52:48 +0000 (03:52 -0500)
commitab192eb46071dc4d104015c3ad374d4f17da3bd2
tree1ec3214c7b00cbb9ca1101ffb036f9ca59473c57
parentbab4cfed357919260e83c2eef0941ee649ae34fd
doc: add Sphinx framework for building docs

I can't get numpydoc working.  Enabling the module raises lots of
warnings:

  $ PYTHONPATH=.. make SPHINXBUILD=sphinx-build-2.7 dirhtml
  ...
  Traceback (most recent call last):tools
    File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 321, in import_object
      __import__(self.modname)
  ImportError: No module named TestRFFT
  Traceback (most recent call last):
    File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 321, in import_object
      __import__(self.modname)
  ImportError: No module named TestUnitaryRFFT

  /.../FFT-tools/doc/source/mod/FFT_tools.rst:64: WARNING: autodoc can't import/find exception 'FFT_tools.TestRFFT.failureException', it reported error: "No module named TestRFFT", please check your spelling and sys.path
  /.../FFT-tools/doc/source/mod/FFT_tools.rst:64: WARNING: failed to import object FFT_tools.TestRFFT.failureException
  /.../FFT-tools/doc/source/mod/FFT_tools.rst:64: WARNING: toctree references unknown document u'mod/FFT_tools.TestRFFT.addCleanup'
  ...
  None:None: WARNING: toctree contains reference to nonexisting document 'mod/FFT_tools.TestRFFT.addCleanup'
  ...
  <autosummary>:None: WARNING: toctree contains reference to nonexisting document 'mod/FFT_tools.TestRFFT.addCleanup'
  ...
.gitignore
doc/Makefile [new file with mode: 0644]
doc/source/.gitignore [new file with mode: 0644]
doc/source/_static/.gitignore [new file with mode: 0644]
doc/source/_templates/.gitignore [new file with mode: 0644]
doc/source/conf.py [new file with mode: 0755]
doc/source/index.rst [new file with mode: 0644]