Skip to content
Snippets Groups Projects
  1. Jan 18, 2013
  2. Jan 17, 2013
  3. Jan 16, 2013
  4. Jan 15, 2013
    • Michael Hanselmann's avatar
      Link man pages in documentation · 5ce58234
      Michael Hanselmann authored
      
      This patch depends on “Option to include man pages in documentation”. In
      the documentation build including man pages, all “:manpage:`…`”
      references are converted to links. For man pages not provided by Ganeti,
      Sphinx' standard formatting is used.
      
      A small dance is necessary to hook into Sphinx' processing of man page
      roles and to generate automatically resolved links. The code converts
      “:manpage:`…`” for known man pages to the data structure equivalent of
      “:doc:`$name($section) <man-$name>`”. Additionally it checks the section
      numbers and formatting of references (in all builds).
      
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      5ce58234
    • 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
  5. Jan 14, 2013
  6. Jan 10, 2013
    • Michael Hanselmann's avatar
      Generate documentation from build directory · 7cf58cad
      Michael Hanselmann authored
      
      When man pages should be included they need to be copied from man/*.rst.
      This means documentation can no longer be built from the static reST
      files alone (which are referenced using “abs_top_srcdir”). Similar to
      Python files, automake doesn't copy or link the input files for
      documentation into the build tree.
      
      This patch adds all files required to build the documentation to
      “srclink_files”, renames the “docrst" variable to “docinput”, and then
      references the files in the build tree using “abs_top_builddir”.
      
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      7cf58cad
    • Michael Hanselmann's avatar
      Add script to check man page references · 58997abb
      Michael Hanselmann authored
      
      This script checks for some of the most obvious mistakes when formatting
      man page references (which should have the form “**ganeti**\(7)”). While
      this works now, it is very hard to avoid ambiguities (e.g. references
      within verbatim blocks) when using regular expressions.
      
      Also fixes a typo in Makefile.am by replacing “harcoded” with
      “hardcoded”.
      
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      58997abb
  7. Jan 09, 2013
  8. Jan 08, 2013
  9. Jan 07, 2013
  10. Jan 04, 2013
  11. Dec 28, 2012
  12. Dec 27, 2012
  13. Dec 24, 2012
  14. Dec 22, 2012
  15. Dec 21, 2012
Loading