Skip to content
The new Git Extensions Manual repository
Branch: master
Clone or download
Pull request Compare This branch is 150 commits ahead of martinqt:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx
source
.gitattributes
.gitignore
GitExtensions.settings
Makefile
UpdateTranslations.cmd
compile_translation.cmd
make-HTMLHelp.cmd add different html output scripts Mar 24, 2013
make-html.cmd
make-singlehtml.cmd
make.cmd
make_and_start_Browser.cmd
make_and_start_MsHtmlHelp.cmd
readme.md
update_pot.cmd

readme.md

Git Extensions Manual

This repository contains the new Git extensions Manual. Feel free to help us improve this manual by sending pull requests or by opening issues.

Refer to the Wiki here: https://github.com/gitextensions/gitextensions/wiki for details on how to update the documentation.

View Online

The current documentation can be viewed here: https://git-extensions-documentation.readthedocs.org/en/latest/

PDF and other formats can be downloaded here: https://readthedocs.org/projects/git-extensions-documentation/downloads/

Note: Only the HTML format is "supported" (i.e. from the display point of view). Other formats might have layout issues but the content remains the same for all formats, whether or not you build it locally (provided your local clone is up to date).

Build

To generate the documentation, you need to have Sphinx installed: http://www.sphinx-doc.org/en/master/usage/installation.html#windows The following installs and build the GE html documentation for any Python package with PIP included:

  • pip install -U sphinx
  • sphinx-build -b html -d build/doctrees source build/html

HTML

Simply run make-html.cmd. You can also use make-singlehtml.cmd to generate a single HTML file. The make_and_start_Browser.cmd is an alias of make-html.cmd that will open in your default browser the documentation main index.

HTML Help Files

Warning: This format is not completely supported (i.e. you can generate it but we don't guarantee as good a display quality as for HTML).

Download HTML Help Workshop (http://www.microsoft.com/en-us/download/details.aspx?id=21138).

To build the file, use make-HTMLHelp.cmd

PDF

Warning: This format is not completely supported (i.e. you can generate it but we don't guarantee as good a display quality as for HTML).

To use the PDF builder, you'll need to install:

  • rst2pdf easy_install rst2pdf
  • pil easy_install pil

Also add ,'rst2pdf.pdfbuilder' to the source/conf.py file at the line 28. Then run make.cmd pdf.

You can’t perform that action at this time.