/doc/ReadMe.txt

https://bitbucket.org/tortoisehg/hgtk/ · Plain Text · 69 lines · 43 code · 26 blank · 0 comment · 0 complexity · a86ad28192fe9b467ada51d5246460a7 MD5 · raw file

  1. TortoiseHg Documentation
  2. To build this documentation you need sphinx installed. On Ubuntu this
  3. is the python-sphinx package. On Windows your best bet is
  4. easy_install. To build without warnings, you need sphinx 0.6 or later.
  5. To build PDF files you need latex packages. On Ubuntu this is
  6. texlive-latex-extra and all of it's dependencies. On Windows the best
  7. choice is miktex.
  8. Once all of the prerequisites are in place, you can use the makefile to
  9. build targets: html htmlhelp latex
  10. Once latex is built, you have to cd into that output directory and run
  11. make all-pdf to build the actual PDF file.
  12. Once htmlhelp is built, you have to run the actual help compiler on a
  13. Windows machine.
  14. On Windows, if you have no make tool you can use build.bat. If HTML
  15. compiler and miktex are installed you can directly generate chm
  16. (build chm) and pdf (build pdf).
  17. Hacking the source
  18. ==================
  19. Please follow this rules when hacking the doc source files.
  20. - As suggested by Sphinx (see http://sphinx.pocoo.org/rest.html#sections)
  21. use:
  22. *************
  23. Chapter title
  24. *************
  25. Section title
  26. =============
  27. Subsection title
  28. ----------------
  29. Subsubsection title
  30. ^^^^^^^^^^^^^^^^^^^
  31. - To indicate a key or a combination of keys use :kbd:, for example:
  32. :kbd:`Ctrl-A`
  33. - To indicate a label, button or anything that appears in user interfaces
  34. use :guilabel:, for example:
  35. :guilabel:`Commit`
  36. - To indicate a menu choise use :menuselection: and -->, for example:
  37. :menuselection:`TortoiseHg... --> About`
  38. - To indicate a file use :file:, for example:
  39. :file:`.hg/hgrc`
  40. - To indicate a command to enter into command window use :command:, for example:
  41. :command:`hgtk log`
  42. - To indicate a text to enter into a text input field in the GUI use ``, for example:
  43. ``myproxy:8000``