Skip to content
Snippets Groups Projects
  1. Mar 26, 2012
  2. Sep 26, 2011
    • Iustin Pop's avatar
      doc: sphinx config file changes · 1b225415
      Iustin Pop authored
      
      I wanted to just enable another extension (the graphviz one), but then
      I went and did a lot of changes:
      
      - replaced ' with " for consistency with our style guide
      - imported new settings (commented out) that current python-sphinx
        (1.0.7) generates when starting a new project; for the keys that are
        different in 0.6 and 1.0+, I left the 0.6 version until we bump our
        documented version
      - enabled graphviz; needed for a design doc I'm currently working on
      - updated copyright years
      - changed list style from single-line to multi-line
      - added coverage/ dir to exclude_trees
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
      1b225415
  3. Feb 04, 2011
  4. Jun 09, 2010
  5. May 12, 2009
    • Iustin Pop's avatar
      Switch the documentation to sphinx · d17e74b4
      Iustin Pop authored
      This big patch converts the documentation build system to sphinx
      (http://sphinx.pocoo.org/
      
      ). Since that uses reStructuredText sources
      too, there is no change (yet) in the documents themselves, just in the
      build system.
      
      As before, the docs are pre built by the maintainer, and the end-user
      doesn't need sphinx or other rst tools to build the docs. Note that we
      are not distributing PDFs, so building that will require the tools.
      
      The docs will be stored under doc/html and the build system also need an
      extra directory doc/build. These are considered (by automake)
      maintainer-related objects and are removed at maintainer-clean time.
      
      The patch also fixes some small issues: add a docpng variable, add
      doc/api (also generated by maintainer) in maintainer-clean-local, etc.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      d17e74b4
Loading