Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: martinqt/GitExtensionsDoc
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: master
Choose a base ref
...
head repository: gitextensions/GitExtensionsDoc
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
Loading
Showing with 3,288 additions and 3,757 deletions.
  1. +4 −0 .github/FUNDING.yml
  2. +9 −0 .gitignore
  3. +22 −0 .readthedocs.yml
  4. +45 −0 GitExtensions.settings
  5. +2 −8 Makefile
  6. +1 −0 make-html_docker.cmd
  7. +0 −9 make.cmd
  8. +0 −62 progress.md
  9. +42 −18 readme.md
  10. +137 −63 source/branches.rst
  11. +139 −34 source/browse_repository.rst
  12. +5 −3 source/command_line.rst
  13. +95 −51 source/commit.rst
  14. +11 −10 source/conf.py
  15. +111 −0 source/dashboard.rst
  16. +148 −0 source/extensions/settings-ext.py
  17. +51 −0 source/file_history.rst
  18. +80 −0 source/files/settings/GitExtensions.settings
  19. +0 −266 source/getting_started.rst
  20. BIN source/git-extensions-logo-128px.png
  21. BIN source/git-extensions-logo.ico
  22. +33 −16 source/git_extensions.rst
  23. +48 −0 source/github.rst
  24. BIN source/images/account_settings.png
  25. BIN source/images/add_note_context_menu.png
  26. BIN source/images/add_submodules.png
  27. BIN source/images/advance_filter_dialog.png
  28. BIN source/images/apply_patche.png
  29. BIN source/images/blame.png
  30. BIN source/images/branch_name.png
  31. BIN source/images/{ → branches}/branch.png
  32. BIN source/images/branches/branch_toolbar.png
  33. BIN source/images/branches/checkout_branch.png
  34. BIN source/images/branches/create_branch_dialog.png
  35. BIN source/images/branches/delete_branch.png
  36. BIN source/images/branches/merge1.png
  37. BIN source/images/branches/merge2.png
  38. BIN source/images/branches/merge3.png
  39. BIN source/images/branches/merge_context_menu.png
  40. BIN source/images/branches/merge_dialog.png
  41. BIN source/images/branches/new_branch.png
  42. BIN source/images/branches/rebase2.png
  43. BIN source/images/branches/rebase_context_menu.png
  44. BIN source/images/branches/rebase_dialog.png
  45. BIN source/images/branches/refactor_branch.png
  46. BIN source/images/browse/advance_filter_dialog-menu.png
  47. BIN source/images/browse/advance_filter_dialog.png
  48. BIN source/images/browse/commit_contextual_menu.png
  49. BIN source/images/browse/commit_diff_view.png
  50. BIN source/images/browse/find_in_file_tree.png
  51. BIN source/images/browse/quick_filter.png
  52. BIN source/images/checkout_branch.png
  53. BIN source/images/cherry_pick.png
  54. BIN source/images/choose_language.png
  55. BIN source/images/clone.png
  56. BIN source/images/command_line.png
  57. BIN source/images/command_line/command_line.png
  58. BIN source/images/command_line/command_line_usage.png
  59. BIN source/images/command_line_usage.png
  60. BIN source/images/commit/commit_amend_reset_author.png
  61. BIN source/images/commit/commit_dialog.png
  62. BIN source/images/commit/commit_dialog_commit.png
  63. BIN source/images/commit/commit_dialog_spellchecker.png
  64. BIN source/images/commit/commit_menu_edit_ignored.png
  65. BIN source/images/commit/commit_reset_changes.png
  66. BIN source/images/commit_contextual_menu.png
  67. BIN source/images/commit_dialog.png
  68. BIN source/images/commit_dialog_commit.png
  69. BIN source/images/commit_dialog_language.png
  70. BIN source/images/commit_dialog_spellchecker.png
  71. BIN source/images/commit_diff_view.png
  72. BIN source/images/commit_log_stash.png
  73. BIN source/images/compress_database.png
  74. BIN source/images/context_menu_blame.png
  75. BIN source/images/create_branch_dialog.png
  76. BIN source/images/dashboard/clone.png
  77. BIN source/images/dashboard/move_to_category.png
  78. BIN source/images/dashboard/new_repository.png
  79. BIN source/images/dashboard/open_repo.png
  80. BIN source/images/dashboard/start_page.png
  81. BIN source/images/delet_branch.png
  82. BIN source/images/delete_tag.png
  83. BIN source/images/development/GitExt_Menu_Structure_v2_43.png
  84. BIN source/images/file_history.png
  85. BIN source/images/file_history/context_menu_blame.png
  86. BIN source/images/file_history/file_history_blame.png
  87. BIN source/images/file_history/file_history_commit.png
  88. BIN source/images/file_history/file_history_diff.png
  89. BIN source/images/file_history/file_history_view.png
  90. BIN source/images/file_history_diff.png
  91. BIN source/images/generate_or_import_key.png
  92. BIN source/images/git_bash_toolbar.png
  93. BIN source/images/github/github_clone.png
  94. BIN source/images/github/github_create_pr.png
  95. BIN source/images/github/github_menu.png
  96. BIN source/images/github/github_view_pr.png
  97. BIN source/images/github_openssh.png
  98. BIN source/images/github_ssh.png
  99. BIN source/images/gitignore.png
  100. BIN source/images/install/destination.png
  101. BIN source/images/install/git_missing.png
  102. BIN source/images/install/install1.png
  103. BIN source/images/install/install2.png
  104. BIN source/images/install/install3.png
  105. BIN source/images/install/install4.png
  106. BIN source/images/install/install5.png
  107. BIN source/images/install/install6.png
  108. BIN source/images/install/language.png
  109. BIN source/images/install/options.png
  110. BIN source/images/install/ready.png
  111. BIN source/images/install/scope.png
  112. BIN source/images/install/ssh.png
  113. BIN source/images/install/telemetry.png
  114. BIN source/images/install/welcome.png
  115. BIN source/images/lost_found.png
  116. BIN source/images/mail_map.png
  117. BIN source/images/maintenance/compress_database.png
  118. BIN source/images/maintenance/gitignore.png
  119. BIN source/images/maintenance/mail_map.png
  120. BIN source/images/maintenance/recover_objects.png
  121. BIN source/images/maintenance/reflog_revision.png
  122. BIN source/images/maintenance/reflog_show.png
  123. BIN source/images/maintenance/verify_database.png
  124. BIN source/images/manage_remote_repositories.png
  125. BIN source/images/merge1.png
  126. BIN source/images/merge2.png
  127. BIN source/images/merge3.png
  128. BIN source/images/merge_conflicts.png
  129. BIN source/images/merge_dialog.png
  130. BIN source/images/modify_history/amend_commit.png
  131. BIN source/images/modify_history/cherry_pick.png
  132. BIN source/images/modify_history/cherry_pick_context_menu.png
  133. BIN source/images/modify_history/merge_conflicts.png
  134. BIN source/images/modify_history/perforce_p4merge.png
  135. BIN source/images/modify_history/rebase_interactive.png
  136. BIN source/images/modify_history/rebase_interactive_autosquash.png
  137. BIN source/images/modify_history/rebase_interactive_create_fixup_commit.png
  138. BIN source/images/modify_history/rebase_interactive_fixup_commit.png
  139. BIN source/images/modify_history/rebase_onto.png
  140. BIN source/images/modify_history/rebase_onto_commit_selection.png
  141. BIN source/images/modify_history/rebase_onto_commit_selection_from_revision_grid.png
  142. BIN source/images/modify_history/resolve_merge_conflicts.png
  143. BIN source/images/modify_history/resolve_merge_conflicts_menu.png
  144. BIN source/images/modify_history/revert_commit_context_menu.png
  145. BIN source/images/modify_history/revert_commit_dialog.png
  146. BIN source/images/move_to_category.png
  147. BIN source/images/new_branch.png
  148. BIN source/images/new_repository.png
  149. BIN source/images/new_tag.png
  150. BIN source/images/note_editor.png
  151. BIN source/images/notes/add_note_context_menu.png
  152. BIN source/images/notes/note_editor.png
  153. BIN source/images/patche_dialog.png
  154. BIN source/images/patche_dialog_result.png
  155. BIN source/images/patches/apply_patche.png
  156. BIN source/images/{ → patches}/patche.png
  157. BIN source/images/patches/patche_dialog.png
  158. BIN source/images/patches/patche_dialog_result.png
  159. BIN source/images/perforce_p4merge.png
  160. BIN source/images/plugins/jira_commit_hint.png
  161. BIN source/images/pull_dialog.png
  162. BIN source/images/pull_dialog2.png
  163. BIN source/images/pull_dialog3.png
  164. BIN source/images/pull_toolbar.png
  165. BIN source/images/push1.png
  166. BIN source/images/push_dialog.png
  167. BIN source/images/push_toolbar.png
  168. BIN source/images/putty_agent.png
  169. BIN source/images/putty_key_generator1.png
  170. BIN source/images/putty_key_generator2.png
  171. BIN source/images/quick_filter.png
  172. BIN source/images/rebase1.png
  173. BIN source/images/rebase2.png
  174. BIN source/images/rebase_dialog.png
  175. BIN source/images/recover_objects.png
  176. BIN source/images/refactor_branch.png
  177. BIN source/images/remote_repositories.png
  178. BIN source/images/remote_repositories2.png
  179. BIN source/images/remotes/generate_or_import_key.png
  180. BIN source/images/remotes/git_bash_toolbar.png
  181. BIN source/images/remotes/github_account_settings.png
  182. BIN source/images/remotes/manage_remote_repositories.png
  183. BIN source/images/remotes/pull_dialog_fetch.png
  184. BIN source/images/remotes/pull_dialog_merge.png
  185. BIN source/images/remotes/pull_dialog_rebase.png
  186. BIN source/images/remotes/pull_toolbar.png
  187. BIN source/images/remotes/push1.png
  188. BIN source/images/remotes/push_dialog.png
  189. BIN source/images/remotes/putty_generate_or_import_key.png
  190. BIN source/images/remotes/putty_key_generator1.png
  191. BIN source/images/remotes/putty_key_generator2.png
  192. BIN source/images/remotes/remote_repositories.png
  193. BIN source/images/remotes/remote_repositories2.png
  194. BIN source/images/remotes/ssh_bash.png
  195. BIN source/images/reset_changes.png
  196. BIN source/images/resolve_merge_conflicts.png
  197. BIN source/images/revert_commit.png
  198. BIN source/images/settings/appearance.png
  199. BIN source/images/settings/checklist.png
  200. BIN source/images/settings/colors.png
  201. BIN source/images/settings/diff-appearance.png
  202. BIN source/images/settings/diff-common-base-conflict-icons.png
  203. BIN source/images/settings/git.png
  204. BIN source/images/settings/git_extensions.png
  205. BIN source/images/settings/global_settings.png
  206. BIN source/images/settings/range-diff-multiple-select.png
  207. BIN source/images/settings/range-diff-two-select.png
  208. BIN source/images/settings/related_links_location.png
  209. BIN source/images/settings/rev-details-on-the-right.png
  210. BIN source/images/settings/revision_links.png
  211. BIN source/images/settings/settings.png
  212. BIN source/images/settings/show-all-difftools.png
  213. BIN source/images/settings/ssh.png
  214. BIN source/images/settings/start_page.png
  215. BIN source/images/show_untracked.png
  216. BIN source/images/ssh_bash.png
  217. BIN source/images/ssh_folder.png
  218. BIN source/images/start_page.png
  219. BIN source/images/stash/commit_log_stash.png
  220. BIN source/images/stash/commit_log_stash2.png
  221. BIN source/images/stash/stash_dialog.png
  222. BIN source/images/stash/stash_left_panel.png
  223. BIN source/images/stash_dialog.png
  224. BIN source/images/submodules.png
  225. BIN source/images/submodules/add_submodules.png
  226. BIN source/images/submodules/submodules.png
  227. BIN source/images/submodules/submodules_dialog.png
  228. BIN source/images/submodules_dialog.png
  229. BIN source/images/tag.png
  230. BIN source/images/tag/delete_tag.png
  231. BIN source/images/tag/new_tag.png
  232. BIN source/images/tag/tag.png
  233. BIN source/images/translate.png
  234. BIN source/images/translate_window.png
  235. BIN source/images/verify_database.png
  236. BIN source/images/visual_studio/browse.png
  237. BIN source/images/visual_studio/commit.png
  238. BIN source/images/visual_studio/context_menu.png
  239. BIN source/images/visual_studio/git_menu.png
  240. BIN source/images/visual_studio/git_menu_vs2022.png
  241. BIN source/images/visual_studio/pull.png
  242. BIN source/images/visual_studio/push.png
  243. BIN source/images/visual_studio/setting_branch.png
  244. BIN source/images/visual_studio/settings.png
  245. BIN source/images/visual_studio/stash.png
  246. BIN source/images/visual_studio/toolbar.png
  247. BIN source/images/{ → windows_explorer}/explorer_integration.png
  248. BIN source/images/{ → windows_explorer}/explorer_integration_new.png
  249. BIN source/images/worktrees/worktree_context_menu.png
  250. BIN source/images/worktrees/worktree_dialog.png
  251. +28 −20 source/index.rst
  252. +62 −0 source/install.rst
  253. +0 −49 source/integration.rst
  254. +27 −47 source/maintenance.rst
  255. +29 −0 source/manual_settings.rst
  256. +0 −51 source/merge_conflicts.rst
  257. +214 −0 source/modify_history.rst
  258. BIN source/nature2/static/ajax-loader.gif
  259. +0 −540 source/nature2/static/basic.css
  260. BIN source/nature2/static/comment-bright.png
  261. BIN source/nature2/static/comment-close.png
  262. BIN source/nature2/static/comment.png
  263. +0 −19 source/nature2/static/custom.css
  264. +0 −256 source/nature2/static/default.css
  265. +0 −247 source/nature2/static/doctools.js
  266. BIN source/nature2/static/down-pressed.png
  267. BIN source/nature2/static/down.png
  268. BIN source/nature2/static/file.png
  269. +0 −154 source/nature2/static/jquery.js
  270. BIN source/nature2/static/minus.png
  271. +20 −14 source/nature2/static/{nature.css → nature.css_t}
  272. BIN source/nature2/static/plus.png
  273. +0 −123 source/nature2/static/pygments.css
  274. +0 −560 source/nature2/static/searchtools.js
  275. +0 −151 source/nature2/static/sidebar.js
  276. +0 −23 source/nature2/static/underscore.js
  277. BIN source/nature2/static/up-pressed.png
  278. BIN source/nature2/static/up.png
  279. +0 −808 source/nature2/static/websupport.js
  280. +5 −5 source/notes.rst
  281. +52 −0 source/other_tools.rst
  282. +14 −12 source/patches.rst
  283. +241 −0 source/plugins.rst
  284. +80 −86 source/remote_feature.rst
  285. +3 −0 source/requirements.txt
  286. +1,437 −0 source/settings.rst
  287. +32 −0 source/stash.rst
  288. +13 −18 source/submodules.rst
  289. +11 −16 source/tag.rst
  290. +5 −11 source/translations.rst
  291. +13 −0 source/windows_explorer.rst
  292. +19 −0 source/worktrees.rst
  293. +0 −7 source/z_appendix.rst
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# You can add one username per supported platform and one custom link
open_collective: gitextensions
custom: https://github.com/gitextensions/gitextensions/wiki
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
build
source/_build/
*.orig
tx.exe
GitExtensions.settings.backup
.vscode/
source/locale/.doctrees/
/source/__pycache__/
/source/extensions/__pycache__/
*.pyc
22 changes: 22 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: source/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: source/requirements.txt
45 changes: 45 additions & 0 deletions GitExtensions.settings
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<dictionary>
<item>
<key>
<string>RevisionLinkDefs</string>
</key>
<value>
<string>&lt;?xml version="1.0" encoding="utf-16"?&gt;
&lt;ArrayOfGitExtLinkDef xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"&gt;
&lt;GitExtLinkDef&gt;
&lt;SearchInParts&gt;
&lt;RevisionPart&gt;Message&lt;/RevisionPart&gt;
&lt;RevisionPart&gt;LocalBranches&lt;/RevisionPart&gt;
&lt;RevisionPart&gt;RemoteBranches&lt;/RevisionPart&gt;
&lt;/SearchInParts&gt;
&lt;LinkFormats&gt;
&lt;GitExtLinkFormat&gt;
&lt;Caption&gt;Issue {0}&lt;/Caption&gt;
&lt;Format&gt;https://github.com/gitextensions/gitextensionsdoc/issues/{0}&lt;/Format&gt;
&lt;/GitExtLinkFormat&gt;
&lt;/LinkFormats&gt;
&lt;Name&gt;GitHub - issues&lt;/Name&gt;
&lt;SearchPattern&gt;(\s*(,|and)?\s*#\d+)+&lt;/SearchPattern&gt;
&lt;NestedSearchPattern&gt;(\d+)+&lt;/NestedSearchPattern&gt;
&lt;Enabled&gt;true&lt;/Enabled&gt;
&lt;/GitExtLinkDef&gt;
&lt;GitExtLinkDef&gt;
&lt;SearchInParts&gt;
&lt;RevisionPart&gt;Message&lt;/RevisionPart&gt;
&lt;/SearchInParts&gt;
&lt;LinkFormats&gt;
&lt;GitExtLinkFormat&gt;
&lt;Caption&gt;View on GitHub&lt;/Caption&gt;
&lt;Format&gt;https://github.com/gitextensions/gitextensionsdoc/commit/%COMMIT_HASH%&lt;/Format&gt;
&lt;/GitExtLinkFormat&gt;
&lt;/LinkFormats&gt;
&lt;Name&gt;GitHub - commit&lt;/Name&gt;
&lt;SearchPattern&gt;.*&lt;/SearchPattern&gt;
&lt;NestedSearchPattern /&gt;
&lt;Enabled&gt;true&lt;/Enabled&gt;
&lt;/GitExtLinkDef&gt;
&lt;/ArrayOfGitExtLinkDef&gt;</string>
</value>
</item>
</dictionary>
10 changes: 2 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

help:
@echo "Please use \`make <target>' where <target> is one of"
@@ -33,7 +33,6 @@ help:
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@@ -42,7 +41,7 @@ clean:
-rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -W -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

@@ -131,11 +130,6 @@ info:
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
1 change: 1 addition & 0 deletions make-html_docker.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docker run --rm -v %CD%:/docs sphinxdoc/sphinx sphinx-build -b html -d build/doctrees source build/html
9 changes: 0 additions & 9 deletions make.cmd
Original file line number Diff line number Diff line change
@@ -31,7 +31,6 @@ if "%1" == "help" (
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
@@ -153,14 +152,6 @@ if "%1" == "texinfo" (
goto end
)

if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)

if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
62 changes: 0 additions & 62 deletions progress.md

This file was deleted.

60 changes: 42 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,65 @@
Git Extensions Manual
=====================
# 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.

View Online
-----------
The current documentation can be viewed here: https://gitextensions.readthedocs.org/en/latest/
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/>

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

**Note:** Only the HTML is "supported" (i.e: on the display point of view). Other format might have layout issue
but the content remains the same for all format, wether or not you build it locally (provided your local clone is
**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
-----
## Build

To generate the documentation, you need to have Sphinx installed: <https://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

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 completly supported (i.e: you can generate it but we don't
guarantee an as good display quality as for HTML).

Download HTML Help Workshop (http://www.microsoft.com/en-us/download/details.aspx?id=21138).
**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 (<https://www.microsoft.com/en-us/download/details.aspx?id=21138>).

To build the file, use `makeHTMLHelp.cmd`
To build the file, use `make-HTMLHelp.cmd`

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

**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`
- 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 <https://git-extensions-documentation.readthedocs.io/>).
- Edit versions in <https://readthedocs.org/projects/git-extensions-documentation/versions/> (admin privileges needed). Keep relevant versions active.
- Trigger a build for changed versions
Loading