Sphinx: force rebuild of html, including autodoc

python python-sphinx sphinx-apidoc
Phillip B Oldham picture Phillip B Oldham · Jan 9, 2014 · Viewed 7.8k times · Source

Currently, whenever I run sphinx-build, only when there are changes to the source files are the inline docstrings picked up and used. I've tried calling sphinx-build with the -a switch but this seems to have no effect.

How can I force a full rebuild of the HTML output and force autodoc execution?

Answer

J. Katzwinkel picture J. Katzwinkel · Jan 9, 2014

It seems to work if the -E option is used along with -a. I added it to the html target in my Makefile and now changes in docstrings are picked up without updating any .rst files.

Related questions

Automatically Generating Documentation for All Python Package Contents

I'm trying to auto-generate basic documentation for my codebase using Sphinx. However, I'm having difficulty instructing Sphinx to recursively scan my files. I have a Python codebase with a folder structure like: <workspace> └── src └── mypackage ├── __init__.py │ ├── subpackageA │ ├── __…

Read More
Sphinx doesn't find Python packages when using autodoc

I'm trying to create documentation for test Python project before doing it for the real project. My system : Win7 64 bit, python 2.7.5 64 bit. My project name is testDoc. It includes python pakage, named t, which includes 2 modules t1 and t2 and __…

Read More
How to generate HTML Documentation with Python-Sphinx?

I'm working on a Python project using PyCharm and now I need to generate the corresponding API documentation. I'm documenting the code methods and classes using docstrings. I read about Sphinx and Doxygen, with Sphinx being the most recommended right …

Read More