/doc/ReadMe.txt
https://bitbucket.org/tortoisehg/hgtk/ · Plain Text · 69 lines · 43 code · 26 blank · 0 comment · 0 complexity · a86ad28192fe9b467ada51d5246460a7 MD5 · raw file
- TortoiseHg Documentation
- To build this documentation you need sphinx installed. On Ubuntu this
- is the python-sphinx package. On Windows your best bet is
- easy_install. To build without warnings, you need sphinx 0.6 or later.
- To build PDF files you need latex packages. On Ubuntu this is
- texlive-latex-extra and all of it's dependencies. On Windows the best
- choice is miktex.
- Once all of the prerequisites are in place, you can use the makefile to
- build targets: html htmlhelp latex
- Once latex is built, you have to cd into that output directory and run
- make all-pdf to build the actual PDF file.
- Once htmlhelp is built, you have to run the actual help compiler on a
- Windows machine.
- On Windows, if you have no make tool you can use build.bat. If HTML
- compiler and miktex are installed you can directly generate chm
- (build chm) and pdf (build pdf).
- Hacking the source
- ==================
- Please follow this rules when hacking the doc source files.
- - As suggested by Sphinx (see http://sphinx.pocoo.org/rest.html#sections)
- use:
-
- *************
- Chapter title
- *************
- Section title
- =============
- Subsection title
- ----------------
- Subsubsection title
- ^^^^^^^^^^^^^^^^^^^
- - To indicate a key or a combination of keys use :kbd:, for example:
- :kbd:`Ctrl-A`
-
- - To indicate a label, button or anything that appears in user interfaces
- use :guilabel:, for example:
- :guilabel:`Commit`
- - To indicate a menu choise use :menuselection: and -->, for example:
- :menuselection:`TortoiseHg... --> About`
-
- - To indicate a file use :file:, for example:
- :file:`.hg/hgrc`
-
- - To indicate a command to enter into command window use :command:, for example:
- :command:`hgtk log`
- - To indicate a text to enter into a text input field in the GUI use ``, for example:
- ``myproxy:8000``