Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Nov 11, 2024. It is now read-only.

automodapi - :no-main-docstr: breaks links #243

Closed
saimn opened this issue Jul 5, 2016 · 2 comments
Closed

automodapi - :no-main-docstr: breaks links #243

saimn opened this issue Jul 5, 2016 · 2 comments

Comments

@saimn
Copy link
Contributor

saimn commented Jul 5, 2016

When I use something like

.. automodapi:: mpdaf.tools
   :no-main-docstr:

I then get a lot of warnings about wrong references, and the generated doc does not have the links to functions/methods. Example for one function:

/home/simon/dev/mpdaf/doc/tools.rst:52: WARNING: failed to import copy_header
...
/home/simon/dev/mpdaf/doc/tools.rst:52: WARNING: toctree references unknown document u'api/copy_header'
...
/home/simon/dev/mpdaf/doc/api/mpdaf.tools.copy_header.rst:: WARNING: document isn't included in any toctree
...

It means that the generated autostuff code does not have correct references. Adding :no-main-docstr: has only one effect in the generated RST, it removes a line :

.. automodule:: {modname}

But then the generated code also has a .. currentmodule: directive, so everything should be ok. Any idea of what could be wrong here ?

@saimn saimn changed the title automodapi - :no-main-docstr: breaks links automodapi - :no-main-docstr: breaks links Jul 5, 2016
@bsipocz
Copy link
Member

bsipocz commented Jun 4, 2017

automodapi got moved to https://github.com/astropy/sphinx-automodapi, so please reopen there is this is still relevant.

@bsipocz bsipocz closed this as completed Jun 4, 2017
@saimn
Copy link
Contributor Author

saimn commented Jun 4, 2017

For the record, I think it was closed by astropy/sphinx-automodapi@b4ea013 but I didn't test.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants