Skip to content

autosummary fails with numpydoc where napoleon succeeds #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mattip opened this issue Apr 3, 2019 · 1 comment
Closed

autosummary fails with numpydoc where napoleon succeeds #204

mattip opened this issue Apr 3, 2019 · 1 comment

Comments

@mattip
Copy link
Member

mattip commented Apr 3, 2019

In merging randomgen to numpy, I changed from napoleon to numpydoc and the build could not link to autogenerated docs.

Here is the diff

diff --git a/doc/source/conf.py b/doc/source/conf.py
index d4290d17..6fd7bcb5 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -43,8 +43,9 @@ release = randomgen.__version__
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.napoleon',
+    #'sphinx.ext.napoleon',
     'sphinx.ext.autodoc',
+    'numpydoc',
     'sphinx.ext.extlinks',
     'sphinx.ext.todo',
     'sphinx.ext.doctest',

And here are the top few warnings, there are thousands more

building [mo]: targets for 0 po files that are out of date
building [html]: targets for 198 source files that are out of date
updating environment: 198 added, 0 changed, 0 removed
reading sources... [100%] references                                                                                                          
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.jump'
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.random_raw'
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.seed'
...

Any hints?

@mattip
Copy link
Member Author

mattip commented Apr 3, 2019

Duplicate of #184

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

No branches or pull requests

1 participant