diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2019-11-22 11:38:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-22 11:38:45 +0100 |
| commit | 431878d251617d60a3e44d1693976dca90630342 (patch) | |
| tree | aa0ed74a236d86f6dcc98686bd4d1edaf9e82665 | |
| parent | 0516d857b056df560f256dbe8ca9e7b1282b4d17 (diff) | |
| parent | ffb47d7dd27fc90860215c729a34b9ebe072ea90 (diff) | |
| download | PROJ-431878d251617d60a3e44d1693976dca90630342.tar.gz PROJ-431878d251617d60a3e44d1693976dca90630342.zip | |
Merge pull request #1735 from rouault/doc_github_button
Doc: configure the 'Edit on GitHub' button
| -rw-r--r-- | HOWTO-RELEASE | 3 | ||||
| -rw-r--r-- | docs/source/conf.py | 6 |
2 files changed, 9 insertions, 0 deletions
diff --git a/HOWTO-RELEASE b/HOWTO-RELEASE index 865dbcf2..0911486e 100644 --- a/HOWTO-RELEASE +++ b/HOWTO-RELEASE @@ -243,3 +243,6 @@ If the previous active version was, let's say, 6.1 and the new version is, let's then checkout 6.1 branch, and in travis/after_success.sh, remove the code that causes commits to 6.1 to cause a website refresh, that is remove the code under `if test "$TRAVIS_SECURE_ENV_VARS" = "true" -a "$TRAVIS_BRANCH" = "6.1"; then`. + +Also edit docs/source/conf.py to change the active branch for documentation +in the `github_version` variable. diff --git a/docs/source/conf.py b/docs/source/conf.py index cd004777..914d8bba 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -171,6 +171,12 @@ html_logo = '../images/logo.png' html_static_path = ['_static'] html_context = { + 'display_github': True, + 'theme_vcs_pageview_mode': 'edit', + 'github_user': 'OSGeo', + 'github_repo': 'PROJ', + # TODO: edit when switching active branch + 'github_version': '/6.2/docs/source/', 'css_files': [ '_static/theme_overrides.css', # override wide tables in RTD theme ], |