title: How to generate html documents from docstring
body: <p>I have a Python project, and wrote many docstring in functions,</p>
  
  <p>how to convert those docstring into html documentation in one or two steps,</p>
  
  <p>I just want the Sphinx can act as doxygen, just convert all my comments or doctring into html documentation.</p>
  
  <p>I run the <code>sphinx-quickstart</code> under the <code>docs</code> folder</p>
  
  <p>then</p>
  
  <pre><code>&gt; autodoc: automatically insert docstrings from modules (y/n) [n]: y
  </code></pre>
  
  <p>then modified the conf.py <code>long_term_streaming_monitor/docs/source/conf.py</code></p>
  
  <pre><code>sys.path.insert(0, os.path.abspath('../../src'))
  </code></pre>
  
  <p>Because all of my source code are put under <code>long_term_streaming_monitor/src</code></p>
  
  <p>The generated code is here <a href="https://www.dropbox.com/s/ot3dw3oulxd1w3q/build.zip" rel="noreferrer">download</a></p>
  
  <p>I followed the tutorial, but when I opened the index.html I got nothing, no module and methods listed on the html file
  <a href="https://pythonhosted.org/an_example_pypi_project/sphinx.html" rel="noreferrer">link</a></p>
  
  <pre><code>.
  ├── docs
  │   ├── _build
  │   │   ├── doctrees
  │   │   └── html
  │   │       ├── _sources
  │   │       └── _static
  │   ├── _static
  │   ├── _templates
  │   └── html
  └── src
      ├── long_term_streaming_monitor
      │   ├── log
      │   ├── scripts
      │   └── tests
      │       └── log
      └── long_term_streaming_monitor_.egg-info
  </code></pre>