Source

sphinx-gsoc2009 / doc / webapp / building.rst

Building a webapp along with documentation

Building your documentation along with a web application, which will serve it, is almost as simple as building the documentation itself.

  • Start a new Sphinx project:

    $ mkdir sphinx-project
    
    $ cd sphinx-project
    
    $ sphinx-quickstart
    
    [ ...usual sphinx-quickstart questions... ]
    
  • The documentation is empty as for now. Create at least one file with some content. Now, you can build a webapp which will serve your documentation

    $ make webapp
    
    [...]
    
    Build finished. The webapp HTML pages are in _build/webapp.
    
  • Run the server

    $ cd _build/webapp/
    
    $ python server.py
    
    Running at 127.0.0.1:8000...
    

OK, there it goes. Now you can check it with web browser!