From 0edea5f44f5126a4e50b6713e4b3996a6c1dc20c Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 7 Oct 2019 11:44:13 +0000 Subject: Add logo to website --- docs/source/conf.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index dd7adc2d..010234dc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -130,8 +130,20 @@ html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -html_theme_options = {} - +html_theme_options = { + 'canonical_url': 'https://proj.org', + 'logo_only': True, + 'display_version': True, + 'prev_next_buttons_location': 'both', + 'style_external_links': False, + 'style_nav_header_background': '#353130', + # Toc options + 'collapse_navigation': True, + 'sticky_navigation': True, + #'navigation_depth': 4, + 'includehidden': True, + 'titles_only': False +} # Add any paths that contain custom themes here, relative to this directory. @@ -144,7 +156,7 @@ html_theme_options = {} # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = '../../media/logo.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -- cgit v1.2.3 From 9d29cd49012ac3bd3d31b7764c6549f3c3a45ba2 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Wed, 16 Oct 2019 12:02:33 +0000 Subject: Use dedicated logo for website Fixes #1670 --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index 010234dc..b5b1f3bc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -156,7 +156,7 @@ html_theme_options = { # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = '../../media/logo.png' +html_logo = '../images/logo.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -- cgit v1.2.3 From 1acb10c65f8092f6b91b037557494bc7c60ad417 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Wed, 30 Oct 2019 16:41:10 +0000 Subject: Doc: add a redirects extension, and make a projjson.html redirect at the top to its current location --- docs/source/conf.py | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index b5b1f3bc..2c4d6f5c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,6 +20,7 @@ import datetime # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('_extensions')) import bibstyle @@ -35,6 +36,7 @@ extensions = [ 'sphinx.ext.mathjax', 'sphinxcontrib.bibtex', 'breathe', + 'redirects', ] # Add any paths that contain templates here, relative to this directory. @@ -370,3 +372,6 @@ texinfo_documents = [ breathe_projects = { "cpp_stuff":"../build/xml/", } + +import redirects +redirect_files = redirects.gather_redirects() -- cgit v1.2.3 From f95d199570dff2724f51b5e00b5fa0e4d00d3b33 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Fri, 1 Nov 2019 19:40:39 +0100 Subject: Bump version number of website --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index 2c4d6f5c..2978293d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -68,7 +68,7 @@ copyright = u'1983-{0}'.format(now.year) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. -version = '6.2.0' +version = '6.2.1' # use same |release| as |version| release = version -- cgit v1.2.3 From 8fd80245180edd4652d8db70ae5b3437c5fee3e1 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Thu, 21 Nov 2019 20:06:17 +0100 Subject: Doc: configure the 'Edit on GitHub' button --- docs/source/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index 2978293d..1008b79e 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 ], -- cgit v1.2.3