search

phn / pytpm

Python interface to the Telescope Pointing Machine C library.
http://phn.github.io/pytpm/
Other
11 stars 4 forks source link

Building docs fails with ImportError for tpm #3

Closed cdeil closed 12 years ago

cdeil commented 12 years ago

I tried to build the pytpm docs locally with the usual 'cd doc; make html', which results in an ImportError.

christoph-deils-macbook:doc deil$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.2pre

Exception occurred:
  File "/Users/deil/code/pytpm/pytpm/__init__.py", line 14, in <module>
    from . import tpm
ImportError: cannot import name tpm
The full traceback has been saved in /var/folders/9v/3cf9p8mx0n1gzcsq3mw9799m0000gn/T/sphinx-err-HQgFtd.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1
christoph-deils-macbook:doc deil$ cat /var/folders/9v/3cf9p8mx0n1gzcsq3mw9799m0000gn/T/sphinx-err-HQgFtd.log
# Sphinx version: 1.2pre
# Python version: 2.7.2
# Docutils version: 0.8.1 release
# Jinja2 version: 2.6
Traceback (most recent call last):
  File "/Users/deil/Library/Python/2.7/lib/python/site-packages/Sphinx-1.2pre_7832936c6f4edev_20120325-py2.7.egg/sphinx/cmdline.py", line 189, in main
    warningiserror, tags)
  File "/Users/deil/Library/Python/2.7/lib/python/site-packages/Sphinx-1.2pre_7832936c6f4edev_20120325-py2.7.egg/sphinx/application.py", line 102, in __init__
    confoverrides or {}, self.tags)
  File "/Users/deil/Library/Python/2.7/lib/python/site-packages/Sphinx-1.2pre_7832936c6f4edev_20120325-py2.7.egg/sphinx/config.py", line 220, in __init__
    exec code in config
  File "/Users/deil/code/pytpm/doc/conf.py", line 54, in <module>
    import pytpm
  File "/Users/deil/code/pytpm/pytpm/__init__.py", line 14, in <module>
    from . import tpm
ImportError: cannot import name tpm
phn commented 12 years ago

Hello,

Are you running this from the doc directory in the git repository?

If so, the reason for the error is that in conf.py I add ".." to the Python system path. So the pytpm module in the repository gets imported and not the one that you have installed. Unless you have run python setup.py build and then python setup.py build_ext --inplace the tpm.so and convert.so files will not be present in pytpm directory. This causes Sphinx to throw the exception.

I do this so that I can test the documents with the current commit.

If you want to create the documents from within the git repo then, run the above two setup.py commands, and then go into doc and run make html.

Or, install the package, and then either copy the doc directory to another place or download the document source, and run make html.

After installing you can also comment out the line

sys.path.insert(0, os.path.abspath('..'))

in doc/conf.py and then run "make html".

In the above two cases the installed version of pytpm will get used.

Let me know if this works.

Prasanth

cdeil commented 12 years ago

Exactly, I was running make html from the doc folder in the git repo, after running python setup.py install --user

Running the commands you suggest works, although there are 200 warnings, so in case you are interested I paste the output below. I'm not sure the warnings are correct, the docs seem fine!?

Would it be possible to change conf.py so that "the usual procedure" works:

git pull <package_URL>
cd <package>
python setup.py install --user
cd doc
make html

I believe this works for most (all?) other packages I have installed so far (including numpy, scipy, scikits statsmodels and learn, pandas, ... some of them use cython as well; sorry I don't have time to look how they wrote their conf.py to make it work), so maybe you can make this work somehow or if not include a note in the README:

How to build the docs
------------------------------
python setup.py build
python setup.py build_ext --inplace
cd doc
make html

Thank you!

ip0x0948:~ deil$ cd code/pytpm/
ip0x0948:pytpm deil$ python setup.py build
running build
running build_py
running egg_info
writing PyTPM.egg-info/PKG-INFO
writing top-level names to PyTPM.egg-info/top_level.txt
writing dependency_links to PyTPM.egg-info/dependency_links.txt
reading manifest file 'PyTPM.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no previously-included files matching '*' found under directory 'doc/_build'
warning: no previously-included files matching '*exe' found under directory 'pytpm/tests/c_tests'
warning: no previously-included files matching '*pyc' found under directory 'data'
warning: no previously-included files found matching 'setup-devel.py'
warning: no previously-included files matching '*pxd' found under directory 'src'
warning: no previously-included files matching '*pxi' found under directory 'src'
warning: no previously-included files matching '*pyx' found under directory 'src'
writing manifest file 'PyTPM.egg-info/SOURCES.txt'
running build_ext
ip0x0948:pytpm deil$ python setup.py build_ext --inplace
running build_ext
copying build/lib.macosx-10.7-x86_64-2.7/pytpm/tpm.so -> pytpm
copying build/lib.macosx-10.7-x86_64-2.7/pytpm/convert.so -> pytpm
ip0x0948:pytpm deil$ cd doc/
ip0x0948:doc deil$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.2pre
loading pickled environment... not yet created
building [html]: targets for 8 source files that are out of date
updating environment: 8 added, 0 changed, 0 removed
/Users/deil/Library/Python/2.7/lib/python/site-packages/numpydoc/docscrape.py:117: UserWarning: Unknown section Return                                                             
  warn("Unknown section %s" % key)
reading sources... [100%] installation                                                                                                                                             
/Users/deil/code/pytpm/doc/_templates/class.rst:4: ERROR: Error in "currentmodule" directive:
maximum 1 argument(s) allowed, 3 supplied.

.. currentmodule:: {{ module }}
/Users/deil/code/pytpm/doc/_templates/class.rst:6: WARNING: invalid signature for autoclass (u'{{ objname }}')
/Users/deil/code/pytpm/doc/_templates/class.rst:6: WARNING: don't know which module to import for autodocumenting u'{{ objname }}' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
/Users/deil/code/pytpm/doc/data_structures.rst:53: WARNING: toctree references unknown document u'pytpm.tpm.DMS.dd'
/Users/deil/code/pytpm/doc/data_structures.rst:53: WARNING: toctree references unknown document u'pytpm.tpm.DMS.mm'
/Users/deil/code/pytpm/doc/data_structures.rst:53: WARNING: toctree references unknown document u'pytpm.tpm.DMS.ss'
/Users/deil/code/pytpm/doc/data_structures.rst:41: WARNING: toctree references unknown document u'pytpm.tpm.HMS.hh'
/Users/deil/code/pytpm/doc/data_structures.rst:41: WARNING: toctree references unknown document u'pytpm.tpm.HMS.mm'
/Users/deil/code/pytpm/doc/data_structures.rst:41: WARNING: toctree references unknown document u'pytpm.tpm.HMS.ss'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.y'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.m'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.dd'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.hh'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.mm'
/Users/deil/code/pytpm/doc/data_structures.rst:59: WARNING: toctree references unknown document u'pytpm.tpm.YMD.ss'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.JD.dd'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.JD.hh'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.JD.mm'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.JD.ss'
/Users/deil/code/pytpm/doc/data_structures.rst:27: WARNING: toctree references unknown document u'pytpm.tpm.V3CP.x'
/Users/deil/code/pytpm/doc/data_structures.rst:27: WARNING: toctree references unknown document u'pytpm.tpm.V3CP.y'
/Users/deil/code/pytpm/doc/data_structures.rst:27: WARNING: toctree references unknown document u'pytpm.tpm.V3CP.z'
/Users/deil/code/pytpm/doc/data_structures.rst:34: WARNING: toctree references unknown document u'pytpm.tpm.V3SP.r'
/Users/deil/code/pytpm/doc/data_structures.rst:34: WARNING: toctree references unknown document u'pytpm.tpm.V3SP.alpha'
/Users/deil/code/pytpm/doc/data_structures.rst:34: WARNING: toctree references unknown document u'pytpm.tpm.V3SP.delta'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.x'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.y'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.z'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.xdot'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.ydot'
/Users/deil/code/pytpm/doc/data_structures.rst:39: WARNING: toctree references unknown document u'pytpm.tpm.V6C.zdot'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.r'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.alpha'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.delta'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.rdot'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.alphadot'
/Users/deil/code/pytpm/doc/data_structures.rst:46: WARNING: toctree references unknown document u'pytpm.tpm.V6S.deltadot'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.utc'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.delta_at'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.delta_ut'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.lon'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.lat'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.alt'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.xpole'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.ypole'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.T'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.P'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.H'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.wavelength'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.tai'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.tdt'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.tdb'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.obliquity'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.nut_lon'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.nut_obl'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.nm'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.pm'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.ut1'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.gmst'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.gast'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.last'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.eb'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.eh'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.obs_m'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.obs_t'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.obs_s'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.refa'
/Users/deil/code/pytpm/doc/data_structures.rst:70: WARNING: toctree references unknown document u'pytpm.tpm.TSTATE.refb'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/deil/code/pytpm/doc/_templates/class.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] installation                                                                                                                                              
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.dd'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.mm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.ss'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.hh'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.mm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.ss'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.y'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.m'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.dd'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.hh'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.mm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.ss'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.dd'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.hh'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.mm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.ss'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.x'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.y'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.z'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.r'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.alpha'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.delta'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.x'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.y'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.z'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.xdot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.ydot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.zdot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.r'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.alpha'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.delta'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.rdot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.alphadot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.deltadot'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.utc'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.delta_at'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.delta_ut'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.lon'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.lat'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.alt'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.xpole'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.ypole'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.T'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.P'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.H'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.wavelength'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tai'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tdt'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tdb'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obliquity'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nut_lon'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nut_obl'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.pm'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.ut1'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.gmst'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.gast'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.last'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.eb'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.eh'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_m'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_t'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_s'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.refa'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.refb'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.dd'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.mm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.DMS.ss'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.hh'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.mm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.HMS.ss'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.y'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.m'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.dd'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.hh'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.mm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.YMD.ss'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.dd'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.hh'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.mm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.JD.ss'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.x'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.y'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3CP.z'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.r'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.alpha'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V3SP.delta'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.x'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.y'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.z'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.xdot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.ydot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6C.zdot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.r'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.alpha'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.delta'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.rdot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.alphadot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.V6S.deltadot'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.utc'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.delta_at'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.delta_ut'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.lon'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.lat'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.alt'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.xpole'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.ypole'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.T'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.P'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.H'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.wavelength'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tai'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tdt'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.tdb'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obliquity'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nut_lon'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nut_obl'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.nm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.pm'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.ut1'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.gmst'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.gast'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.last'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.eb'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.eh'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_m'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_t'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.obs_s'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.refa'
None:None: WARNING: toctree contains reference to nonexisting document 'pytpm.tpm.TSTATE.refb'
writing additional files... genindex search
copying downloadable files... [100%] /Users/deil/code/pytpm/doc/examples/hip_full.txt                                                                                              
copying static files... WARNING: html_static_path entry '/Users/deil/code/pytpm/doc/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 200 warnings.

Build finished. The HTML pages are in _build/html.
phn commented 12 years ago

Hello,

The warnings are from the numpydoc extension, and after searching for and trying out various potential solutions, I still can't stop them. But as you say the output Sphinx docs don't seem to have any major defects.

The only reason that I have the current setup is that, I regularly test the docs against the code in the repository as opposed to the installed one. So I would like to keep it the way it is for now.

I am planning a complete re-write of the code, now that I know a lot more about Python than I knew before starting the project! I will make a lot of changes (see issue #2) when I get time to start the re-write; I will incorporate your suggestions.

Thanks for the suggestions.

Prasanth

scopatz commented 11 years ago

You may be able to get rid of these warning by setting numpydoc_show_class_members = False in your conf.py. This worked for me at least. The real problem is that the numpydoc.docscrape_sphinx.SphinxDocString._str_member_list() method produces autosummary code which does not work because it gets inserted after autosummary runs in the sphinx pipeline. (Or at least that is my current best guess.)

ndawe commented 11 years ago

Thanks @scopatz! Messed around for hours before finding your suggestion. Works for me too.

scopatz commented 11 years ago

@ndawe glad this helped!