Force Sphinx to interpret Markdown in Python docstrings instead of reStructuredText Question: I’m using Sphinx to document a python project. I would like to use Markdown in my docstrings to format them. Even if I use the recommonmark extension, it only covers the .md files written manually, not the docstrings. I use autodoc, napoleon and …
Can Sphinx napoleon document function returning multiple arguments? Question: I am trying to use the Google code style to document a function that I then use sphinx with the napoleon extension to create documentation for. The function is unusual in that is returns two arguments. I don’t think napoleon handles this. If so, could someone …
Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats) Question: Does PyCharm 2.7 (or will PyCharm 3) have support for custom docstring and doctest stubs? If so, how does one go about writing this specific type of custom extension? My current project has standardized on using the Google Python Style Guide (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). I …
Sphinx autosummary "toctree contains reference to nonexisting document" warnings Question: 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 get rst docs successfully created in my output directory for the packages and top-level modules. However, when I …
