Skip to content
Snippets Groups Projects
  1. Aug 13, 2009
  2. Aug 12, 2009
  3. Aug 11, 2009
  4. Aug 10, 2009
  5. Aug 08, 2009
  6. Aug 07, 2009
  7. Aug 06, 2009
  8. Aug 05, 2009
  9. Aug 04, 2009
  10. Aug 03, 2009
  11. Jul 31, 2009
  12. Jul 30, 2009
  13. Jul 22, 2009
  14. Jul 21, 2009
  15. Jul 17, 2009
  16. Jul 16, 2009
  17. Jul 13, 2009
  18. Jul 07, 2009
  19. Jun 19, 2009
  20. Jun 18, 2009
  21. Jun 04, 2009
  22. May 21, 2009
  23. May 14, 2009
  24. May 13, 2009
  25. May 12, 2009
    • Iustin Pop's avatar
      Some small doc updates · fd07c6b3
      Iustin Pop authored
      
      We change some formatting to sphinx-specific, to show how the
      documentation can be improved.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      fd07c6b3
    • Iustin Pop's avatar
      Move the glossary to a separate file · e2078d28
      Iustin Pop authored
      
      Currently we have an insignificant glossary at the end of the design-2.0
      document. This patch moves it to a separate file with the goal that it
      will grow and all files can refer to it.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      e2078d28
    • 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
    • Iustin Pop's avatar
      Convert from auto-generated RAPI docs to static · 6d81475c
      Iustin Pop authored
      
      This patch removes the autogeneration of the RAPI docs from the code
      (based on docstrings) and moves the current autogenerated output to
      the rapi.rst file.
      
      The reasons behind this are multiple:
        - the build system becomes a little more simple (this could have been
      	achieved also by distributing the built documentation, though)
        - it's hard to actually write documentation in docstrings; you have to
      	fit restructured text inside the docstrings, and this results in
      	not really nice output
        - even by being close to the code, the documentation manages to get
      	out of sync (not paying attention to docstrings)
      
      This will also help with the move to sphinx.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      6d81475c
  26. May 09, 2009
Loading