crate-docs-theme 0.32.0.dev5__tar.gz → 0.32.0.dev7__tar.gz

{crate_docs_theme-0.32.0.dev5/src/crate_docs_theme.egg-info → crate_docs_theme-0.32.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crate-docs-theme
-Version: 0.32.0.dev5
+Version: 0.32.0.dev7
 Summary: Crate Docs Theme
 Home-page: https://github.com/crate/crate-docs-theme
 Author: Crate.IO GmbH

{crate_docs_theme-0.32.0.dev5 → crate_docs_theme-0.32.0.dev7}/src/crate/theme/rtd/__init__.py

@@ -26,7 +26,7 @@ import os
 VERSION = (0, 31, 1)
 
 #__version__ = ".".join(str(v) for v in VERSION)
-__version__ = "0.32.0dev5"
+__version__ = "0.32.0dev7"
 __version_full__ = __version__
 
 

{crate_docs_theme-0.32.0.dev5 → crate_docs_theme-0.32.0.dev7}/src/crate/theme/rtd/conf/__init__.py

@@ -74,7 +74,6 @@ html_theme_options = {
     # url
     "canonical_url_path": "",
     "canonical_url": "https://cratedb.com/",
-    "custom_canonical_url": "",
     # HubSpot analytics configuration
     "tracking_hubspot_id": environ.get("TRACKING_HUBSPOT_ID", ""),
     "tracking_project": "",

crate_docs_theme-0.32.0.dev7/src/crate/theme/rtd/conf/jdbc.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8; -*-
+#
+# Licensed to Crate (https://crate.io) under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+
+
+from crate.theme.rtd.conf import *
+
+# If you update the `project` value here, you must update it in the
+# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
+# expand the sidebar TOC for this project.
+project = u"CrateDB JDBC"
+html_title = project
+
+# Resolve an intertwingulation between vanilla Sphinx and RTD.
+custom_url_path = "docs/jdbc/en/latest/"
+
+# CrateDB docs are hosted on a custom domain behind Nginx.
+html_baseurl = "https://cratedb.com/%s/" % custom_url_path
+
+ogp_site_url = html_baseurl
+
+# For custom rel="canonical" links.
+# Reason: RTD does something silly with `index` page names.
+html_theme_options.update(
+    {
+        "html_baseurl": html_baseurl,
+    }
+)

{crate_docs_theme-0.32.0.dev5 → crate_docs_theme-0.32.0.dev7}/src/crate/theme/rtd/crate/base.html

@@ -141,7 +141,7 @@
           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
     {%- endif %}
 
-    {%- if theme_custom_canonical_url %}
+    {%- if theme_html_baseurl %}
     {%- if pagename == "index" %}
         {%- set canonical_page = "index.html" %}
     {%- elif pagename.endswith("/index") %}
@@ -154,7 +154,7 @@
     Always link to the latest version, as canonical.
     https://docs.readthedocs.io/en/stable/canonical-urls.html
     -->
-    <link rel="canonical" href="{{ theme_custom_canonical_url|e }}{{ canonical_page }}" />
+    <link rel="canonical" href="{{ theme_html_baseurl|e }}{{ canonical_page }}" />
     {%- endif %}
 
     <link rel="icon" type="image/png" href="{{ pathto('_static', 1) }}/images/favicon.png"/>

{crate_docs_theme-0.32.0.dev5 → crate_docs_theme-0.32.0.dev7}/src/crate/theme/rtd/crate/theme.conf

@@ -46,7 +46,7 @@ source_link_position = nav
 # Needed because RTD only allows root URLs as canonical URL.
 canonical_url_path = docs/
 canonical_url =
-custom_canonical_url =
+html_baseurl =
 
 # HubSpot tracking ID
 tracking_project =

{crate_docs_theme-0.32.0.dev5 → crate_docs_theme-0.32.0.dev7/src/crate_docs_theme.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crate-docs-theme
-Version: 0.32.0.dev5
+Version: 0.32.0.dev7
 Summary: Crate Docs Theme
 Home-page: https://github.com/crate/crate-docs-theme
 Author: Crate.IO GmbH

crate_docs_theme-0.32.0.dev5/src/crate/theme/rtd/conf/jdbc.py

@@ -1,35 +0,0 @@
-# -*- coding: utf-8; -*-
-#
-# Licensed to Crate (https://crate.io) under one or more contributor
-# license agreements.  See the NOTICE file distributed with this work for
-# additional information regarding copyright ownership.  Crate licenses
-# this file to you under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.  You may
-# obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
-# License for the specific language governing permissions and limitations
-# under the License.
-#
-# However, if you have executed another commercial license agreement
-# with Crate these terms will supersede the license and you may use the
-# software solely pursuant to the terms of the relevant commercial agreement.
-
-
-from crate.theme.rtd.conf import *
-
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
-project = u"CrateDB JDBC"
-html_title = project
-
-crate_url_path = "docs/jdbc"
-html_baseurl = "https://cratedb.com/%s/" % crate_url_path
-custom_rtd_language = "/en/latest/"  # Resolve an intertwingulation between vanilla Sphinx and RTD.
-custom_canonical_url = html_baseurl + custom_rtd_language
-ogp_site_url = custom_canonical_url