https://github.com/gitextensions/GitExtensionsDoc

The new Git Extensions Manual repository
https://github.com/gitextensions/GitExtensionsDoc

Last synced: about 2 months ago
JSON representation

The new Git Extensions Manual repository

• Host: GitHub
• URL: https://github.com/gitextensions/GitExtensionsDoc
• Owner: gitextensions
• Fork: true (martinqt/GitExtensionsDoc)
• Created: 2013-01-14T17:44:10.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2023-11-13T21:25:46.000Z (10 months ago)
• Last Synced: 2024-04-13T21:53:32.895Z (5 months ago)
• Language: Python
• Homepage: https://git-extensions-documentation.readthedocs.org/
• Size: 11.7 MB
• Stars: 28
• Watchers: 14
• Forks: 46
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# 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:  for details on how to update the documentation.

## View Online

The current documentation can be viewed here: 

PDF and other formats can be downloaded here: 

**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: 

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

If you have docker installed, you could also generate the documentation using the command in a `cmd` prompt (or run the file `make-html_docker.cmd`):

```

docker run --rm -v %CD%:/docs sphinxdoc/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 ().

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`.

## Version update

- Set version in source/conf.py

- Create release branch release/x.y (this is the default from the GE About menu for released versions, 'master' for development builds).

- When releasing final, push 'latest' branch to release/x.y commit (this branch is the default when browsing ).

- Edit versions in  (admin privileges needed). Keep relevant versions active.

- Trigger a build for changed versions