DOC: switch to book theme, fix the RTD configuration (#235)

* RTD: fix the readthedocs setup

* switch to book theme, fix the rtd setup

* env update

* better solution for the title and subtitle

Author: martinfleis

docs/_templates/docs-sidebar.html

@@ -17,8 +17,9 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 # import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import sys
+sys.path.insert(0, os.path.abspath(".."))
+import contextily  # noqa
 
 
 # -- Project information -----------------------------------------------------
@@ -28,7 +29,7 @@
 author = "Dani Arribas-Bel & Contexily Contributors"
 
 # The full version, including alpha/beta/rc tags
-release = "1.1.0"
+release = contextily.__version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -60,7 +61,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "pydata_sphinx_theme"
+html_theme = "sphinx_book_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -71,8 +72,10 @@
     "css/custom.css",
 ]
 
-html_sidebars = {
-    "**": ["docs-sidebar.html"],
+html_theme_options = {
+    "logo": {
+        "text": "CONTEXTILY <br> Context geo tiles in Python",
+    }
 }
 
 intersphinx_mapping = {

docs/_templates/layout.html

@@ -2,7 +2,7 @@ name: contextily_docs
 channels:
 - conda-forge
 dependencies:
-- python=3.7
+- python=3.11
 # dependencies
 - numpy
 - geopy
@@ -20,4 +20,4 @@ dependencies:
 - nbsphinx
 - pandoc
 - ipython
-- pydata-sphinx-theme
+- sphinx-book-theme

docs/conf.py

@@ -10,7 +10,7 @@ Contents
 --------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: User Guide
 
    intro_guide
@@ -22,7 +22,7 @@ Contents
    friends_cenpy_osmnx
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Reference Guide
 
    reference

docs/environment.yml

@@ -1,9 +1,12 @@
 version: 2
-formats: []
-conda:
-    environment: docs/environment.yml
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-latest
 python:
-    version: 3
-    install:
-        - method: pip
-          path: .
+  install:
+  - method: pip
+    path: .
+conda:
+  environment: docs/environment.yml
+formats: []