From 70eb6e9d05e8b0ec3bb4ab85785b8cba250ae58d Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Fri, 6 May 2022 15:27:01 +0100 Subject: [PATCH] Switch docs back to readthedocs theme (#80) * Revert to sphinx-rtd-theme and store logo in repo * Move readme content to index page --- docs/conf.py | 17 ++--- docs/images/vre_logo_light.svg | 126 +++++++++++++++++++++++++++++++++ docs/index.rst | 16 ++--- docs/readme.rst | 4 -- pyproject.toml | 2 +- 5 files changed, 139 insertions(+), 26 deletions(-) create mode 100644 docs/images/vre_logo_light.svg delete mode 100644 docs/readme.rst diff --git a/docs/conf.py b/docs/conf.py index 6c84dd3..1a123bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,9 +11,7 @@ # 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. # -import os -import sys -import urllib.request + # -- Project information ----------------------------------------------------- @@ -73,13 +71,13 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_book_theme" +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 = {"style_external_links": True} # 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, @@ -96,14 +94,7 @@ # # html_sidebars = {} -# Fetch and use external logo -logo_filename = "vre_logo_light.svg" -if not os.path.exists(logo_filename): - urllib.request.urlretrieve( - "https://raw.githubusercontent.com/ESA-VirES/Swarm-VRE/staging/docs/_static/vre_logo_light.svg", - logo_filename, - ) -html_logo = logo_filename +html_logo = "images/vre_logo_light.svg" # -- Options for HTMLHelp output --------------------------------------------- diff --git a/docs/images/vre_logo_light.svg b/docs/images/vre_logo_light.svg new file mode 100644 index 0000000..d6bae8c --- /dev/null +++ b/docs/images/vre_logo_light.svg @@ -0,0 +1,126 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.rst b/docs/index.rst index dd2d35f..186063e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,22 @@ -Welcome to viresclient's documentation! -=============================================== +Introduction +============ -Get started `at the introduction `_ +.. include:: ../README.rst .. toctree:: :caption: Virtual Research Environments - VirES for Swarm - Swarm Notebooks - VirES for Aeolus - Aeolus Notebooks + 🔗 VirES for Swarm + 🔗 Swarm Notebooks + 🔗 VirES for Aeolus + 🔗 Aeolus Notebooks .. toctree:: :maxdepth: 2 :caption: Information on viresclient - readme + self installation config_details access_token diff --git a/docs/readme.rst b/docs/readme.rst deleted file mode 100644 index 2b9a587..0000000 --- a/docs/readme.rst +++ /dev/null @@ -1,4 +0,0 @@ -Introduction -============ - -.. include:: ../README.rst diff --git a/pyproject.toml b/pyproject.toml index 3aee07b..75bb3f7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,7 +56,7 @@ dev = [ ] docs = [ "Sphinx == 4.5.0", - "sphinx-book-theme == 0.2.0", + "sphinx_rtd_theme == 1.0.0", "sphinx_copybutton == 0.5.0", ]