1. 23 Jun, 2015 1 commit
  2. 15 Jan, 2013 1 commit
    • Michael Hanselmann's avatar
      Option to include man pages in documentation · 41806ef4
      Michael Hanselmann authored
      Before this patch, HTML versions of man pages (man/*.rst) were already
      built. However, since they are separate from the normal documentation,
      their content is not indexed for Sphinx' search functionality.
      Additionally it would simply be nice to have everything in one place.
      
      To this end a new configure-time option is added to enable the inclusion
      of man pages into the documentation. A dedicated option is necessary to
      still be able to provide a static documentation build in the tarball
      (not including man pages) as man pages contain build-specific paths and
      values. The documentation with man pages is written to the directory
      “doc/man-html”.
      
      A future patch will extend Sphinx to link occurences of “:manpage:`…`”
      to these man pages.
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      41806ef4
  3. 14 Jan, 2013 1 commit
  4. 09 Jan, 2013 1 commit
  5. 26 Mar, 2012 1 commit
  6. 26 Sep, 2011 1 commit
    • 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
  7. 04 Feb, 2011 1 commit
  8. 09 Jun, 2010 1 commit
  9. 12 May, 2009 1 commit
    • 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