Skip to content
Snippets Groups Projects
  1. 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
  2. Apr 07, 2009
    • Iustin Pop's avatar
      Distribute built documentation · 2ab2b9f5
      Iustin Pop authored
      This patch changes the way documentation is built in order to distribute
      the generated output in the 'dist' archive, and thus no longer
      requiring the presence of the docbook/rst toolchains during build time.
      This will lower the requirements for installation and also makes the
      build time insignificant.
      
      First, we remove the docbook2pdf rules and variables, since we no longer
      build this kind of docs. Furthermore, the rst source files are not
      (today) processed via replace_vars_sed, so the whole .in rules for doc/
      go away.
      
      Next, we change the ".sgml|.rst -> replace_vars_sed -> .in -> processor
      -> final file" processing to ".sgml|.rst -> generator -> .in ->
      replace_vars_sed -> final file"; this means we first process the file
      using the formatter, with the @VARIABLE@ entries in it, and save the
      output as .in; this output we distribute, and on the user side, the
      replace_vars_sed will use the new configure flags to transform the
      (almost final .in form) to the final form, without needing the
      toolchain.
      
      In configure.ac we also change from ERROR to WARN for the documentation
      generators, and extra tests in Makefile.am check that the programs have
      been found.
      
      This was tested with distcheck and works as expected.
      
      Reviewed-by: ultrotter
      2ab2b9f5
  3. Feb 16, 2009
  4. Nov 16, 2008
    • Iustin Pop's avatar
      Add a cluster architecture diagram · f86e82ef
      Iustin Pop authored
      This adds a simple diagram for the cluster architecture and also adds a
      dependency on graphviz (both doc and in configure).
      
      Reviewed-by: imsnah
      f86e82ef
  5. Sep 30, 2008
  6. Aug 25, 2008
  7. Jul 11, 2008
    • Michael Hanselmann's avatar
      Fix rapi documentation · 081242d8
      Michael Hanselmann authored
      As a nice side-effect this also fixes "make distcheck".
      
      The way used to include the generated rapi-resources.sgml file only
      works if it's built in the same directory. That's not the case during
      "make distcheck". The patch changes the sed script used for variables
      to include the file using its absolute path.
      
      Reviewed-by: iustinp
      081242d8
  8. Oct 10, 2007
Loading