swp-docs
latest

Tutorials

  • Welcome
  • Writing documentation with Sphinx
    • Getting started
    • Publish on Read The Docs
    • Source code documentation
  • Installing Python
  • Installing PyQT
  • Installing OpenCV for Python development

About

  • The SWP Team
swp-docs
  • Docs »
  • Writing documentation with Sphinx
  • Edit on Bitbucket

Writing documentation with Sphinx¶

Contents:

  • Getting started
    • Install and configure sphinx
    • Changing the conf.py file
    • Edit, build, preview cycle
  • Publish on Read The Docs
  • Source code documentation
    • Configuring sphinx
    • Writing documentation
    • Generating an inheritance diagram
    • Auto extracting docstrings from source code
Next Previous

© Copyright 2016, Scientific Software Platform (Champalimaud Foundation). Revision 097694b5.

Built with Sphinx using a theme provided by Read the Docs.