Repository navigation
Fix sphinx build warnings #45
Description
These are generated because automodapi tries to generate docs for things we import -- one fix is to set __all__ to something sensible in each module.
...
/Users/mcraig/Development/astronomy/ccdproc/docs/ccdproc/index.rst:49: WARNING: toctree references unknown document u'api/ccdproc.ccdproc.Quantity'
/Users/mcraig/Development/astronomy/ccdproc/docs/ccdproc/index.rst:49: WARNING: toctree references unknown document u'api/ccdproc.ccdproc.StdDevUncertainty'
...
None:None: WARNING: toctree contains reference to nonexisting document u'api/ccdproc.ccdproc.Quantity'
None:None: WARNING: toctree contains reference to nonexisting document u'api/ccdproc.ccdproc.StdDevUncertainty'
...
Activity
cdeil commentedon May 2, 2014
👍 to adding
__all__... this will also get rid of entries in your Sphinx docs likeNDDatathat are from Astropy:http://ccdproc.readthedocs.org/en/latest/ccdproc/index.html#classes
cdeil commentedon May 2, 2014
Hmmm ... I get a weird error when I try to build the sphinx docs locally:
https://gist.github.com/cdeil/a0ae94e263129b87f455
mwcraig commentedon May 2, 2014
What version of astropy are you using?
cdeil commentedon May 2, 2014
I'm using the latest Astropy master as of a few minutes ago:
astropy==0.4.dev8255
f754c3af4ed1ad30e761cb909f2f4f35179260a3
This looks like a bug in
astropy/sphinx/ext/smart_resolver.pyfromastropy/astropy#2292 to me.
@mwcraig Can you reproduce this issue?
cdeil commentedon May 2, 2014
While you're cleaning up the Sphinx warnings, could you please also add a dot
.at the end of the first line of each docstring?At the moment it's missing for most
ccdprocfunctions / classes, which makes the HTML docs overview output garbled:mwcraig commentedon May 2, 2014
@cdeil
.-- I had no idea why that was happening in some cases!cdeil commentedon May 2, 2014
I'll make an Astropy issue for @mdboom about the sphinx error.
Fix astropy inter sphinx link for building docs with 0.3.1
Fix astropy inter sphinx link for building docs with 0.3.1
Fix astropy inter sphinx link for building docs with 0.3.1
Fix astropy inter sphinx link for building docs with 0.3.1
Fix astropy inter sphinx link for building docs with 0.3.1
Fix astropy inter sphinx link for building docs with 0.3.1
Merge pull request astropy#45 from mdboom/setup/package_data-dont-ove…