Sphinx autosummary “toctree contains reference to nonexisting document” warnings

后端 未结 3 962
耶瑟儿~
耶瑟儿~ 2020-12-25 10:56

I am trying to automatically create api docs for a large python codebase using Sphinx.

I have tried using build_modules.py and sphinx-apidoc. With either one, I can

3条回答
  •  -上瘾入骨i
    2020-12-25 11:32

    If you are using the numpydoc extension, you could consider removing it and using sphinx.ext.napoleon instead.

    Since version 1.3, Numpy and Google style docstrings are in fact supported by this builtin extension.

    Removing numpydoc and using sphinx.ext.napoleon in your conf.py will therefore probably solve your problem.


    Sources

    • Napoleon - Marching toward legible docstrings
    • Sphinx Doc - Support for NumPy and Google style docstrings

提交回复
热议问题