switch the docs Sphinx theme from alabaster to RTD theme

https://sphinx-rtd-theme.readthedocs.io/

Author: snarfed

README.md

@@ -17,16 +17,13 @@ About
 
 This is a collection of drop-in Python [Flask](https://flask.palletsprojects.com/) views for the initial [OAuth](http://oauth.net/) client flows for many popular sites, including Blogger, Disqus, Dropbox, Facebook, Flickr, GitHub, Google, IndieAuth, Instagram, LinkedIn, Mastodon, Medium, Tumblr, Twitter, and WordPress.com.
 
-* [Available on PyPi.](https://pypi.python.org/pypi/oauth-dropins/) Install with `pip install oauth-dropins`.
-* [Click here for getting started docs.](#quick-start)
-* [Click here for reference docs.](https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html)
-* A demo app is deployed at [oauth-dropins.appspot.com](http://oauth-dropins.appspot.com/).
-
 oauth-dropins stores user credentials in [Google Cloud Datastore](https://cloud.google.com/datastore/). It's primarily designed for [Google App Engine](https://appengine.google.com/), but it can be used in any Python web application, regardless of host or framework.
 
-[Versions 3.0](https://pypi.org/project/oauth-dropins/3.0/) and above support App Engine's [Python 3 runtimes](https://cloud.google.com/appengine/docs/python/), both [Standard](https://cloud.google.com/appengine/docs/standard/python3/) and [Flexible](https://cloud.google.com/appengine/docs/flexible/python/). If you're on the [Python 2 runtime](https://cloud.google.com/appengine/docs/standard/python/), use [version 2.2](https://pypi.org/project/oauth-dropins/2.2/).
-
-If you clone the repo directly or want to contribute, see [Development](#development) for setup instructions.
+* [Available on PyPi.](https://pypi.python.org/pypi/oauth-dropins/) Install with `pip install oauth-dropins`.
+* [Getting started docs.](#quick-start)
+* [Reference docs.](https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html)
+* Demo app at [oauth-dropins.appspot.com](http://oauth-dropins.appspot.com/).
+* [Source code on GitHub.](https://github.com/snarfed/oauth-dropins/)
 
 This software is released into the public domain. See LICENSE for details.
 
@@ -391,5 +388,7 @@ Here's how to package, test, and ship a new release. (Note that this is [largely
 
 Related work
 ---
-* [Python Social Auth](https://python-social-auth.readthedocs.io/en/latest/)
 * [Loginpass](https://github.com/authlib/loginpass)/[Authlib](https://authlib.org/)
+* [Authomatic](https://authomatic.github.io/authomatic/)
+* [Python Social Auth](https://python-social-auth.readthedocs.io/en/latest/)
+* [Authl](https://authl.readthedocs.io/en/stable/)

docs/_static/custom.css

@@ -0,0 +1,22 @@
+.icon-home {
+  font-size: larger !important;
+}
+
+.wy-nav-side, .wy-side-nav-search > div.version {
+  color:#fcfcfc;
+}
+
+.rst-content code, .rst-content tt, code {
+  border: none;
+  padding: 0;
+}
+
+/* The first link in the reference doc TOC is the page title/header. Hide that.  */
+#contents #id1 {
+  display: none;
+}
+
+/* The first link in the sidebar TOC is the page title/header. Hide that.  */
+.local-toc ul:nth-child(3) li:first-child {
+  display: none;
+}

docs/_templates/breadcrumbs.html

@@ -0,0 +1 @@
+<hr/>

docs/_templates/description.html

@@ -0,0 +1,36 @@
+{% extends "!layout.html" %}
+
+{%- block navigation %}
+
+
+<div style="width: 300px; text-align: center; font-size: larger">
+
+<p>Drop-in Python OAuth client flows for Flask on Google Cloud.</p>
+
+<!---
+<p>
+<a href="https://circleci.com/gh/snarfed/oauth-dropins">
+  <img alt="Tests on Circle CI" src="https://circleci.com/gh/snarfed/oauth-dropins.svg?style=svg" />
+</a>
+
+<a href="https://coveralls.io/github/snarfed/oauth-dropins?branch=master">
+  <img alt="Coverage on Coveralls" src="https://coveralls.io/repos/github/snarfed/oauth-dropins/badge.svg?branch=master" />
+</a>
+</p>
+-->
+</div>
+
+<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
+<div class="local-toc">
+  <ul>
+    <li><a href="{{ pathto('index') }}">Getting started</a></li>
+    <li><a href="{{ pathto('source/oauth_dropins') }}">oauth_dropins reference</a></li>
+    <li><a href="{{ pathto('source/oauth_dropins.webutil') }}">webutil reference</a></li>
+  </ul>
+  <hr style="margin: 1em">
+  {{ toc }}
+</div>
+</div>
+
+
+{%- endblock %}

docs/_templates/layout.html

@@ -20,11 +20,11 @@ cd `dirname $absfile`
 rm -f index.rst
 cat > index.rst <<EOF
 oauth-dropins
-=============
+-------------
 
 EOF
 
-tail -n +15 ../README.md \
+tail -n +17 ../README.md \
   | pandoc --from=markdown --to=rst \
   | sed -E 's/```/`/; s/`` </ </' \
   >> index.rst

docs/build.sh

@@ -11,6 +11,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sphinx_rtd_theme
 import sys
 import os
 
@@ -37,6 +38,7 @@
     'sphinx.ext.intersphinx',
     # 'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
+    'sphinx_rtd_theme',
 ]
 
 # autodoc settings
@@ -141,12 +143,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+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 = {}
+# https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
+html_theme_options = {
+    'collapse_navigation': False,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -160,7 +165,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = '../oauth_dropins/static/oauth_shiny.png'
+html_logo = '../oauth_dropins/static/oauth_shiny_128.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
@@ -190,6 +195,15 @@
   '**': ['description.html', 'localtoc.html', 'searchbox.html'],
 }
 
+# These folders are copied to the documentation's HTML output
+html_static_path = ['_static']
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+# https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
+html_css_files = [
+    'custom.css',
+]
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}

docs/conf.py

@@ -1,8 +1,5 @@
 oauth-dropins
-=============
-
-About
------
+-------------
 
 This is a collection of drop-in Python
 `Flask <https://flask.palletsprojects.com/>`__ views for the initial
@@ -11,32 +8,21 @@ including Blogger, Disqus, Dropbox, Facebook, Flickr, GitHub, Google,
 IndieAuth, Instagram, LinkedIn, Mastodon, Medium, Tumblr, Twitter, and
 WordPress.com.
 
--  `Available on PyPi. <https://pypi.python.org/pypi/oauth-dropins/>`__
-   Install with ``pip install oauth-dropins``.
--  `Click here for getting started docs. <#quick-start>`__
--  `Click here for reference
-   docs. <https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html>`__
--  A demo app is deployed at
-   `oauth-dropins.appspot.com <http://oauth-dropins.appspot.com/>`__.
-
 oauth-dropins stores user credentials in `Google Cloud
 Datastore <https://cloud.google.com/datastore/>`__. It’s primarily
 designed for `Google App Engine <https://appengine.google.com/>`__, but
 it can be used in any Python web application, regardless of host or
 framework.
 
-`Versions 3.0 <https://pypi.org/project/oauth-dropins/3.0/>`__ and above
-support App Engine’s `Python 3
-runtimes <https://cloud.google.com/appengine/docs/python/>`__, both
-`Standard <https://cloud.google.com/appengine/docs/standard/python3/>`__
-and
-`Flexible <https://cloud.google.com/appengine/docs/flexible/python/>`__.
-If you’re on the `Python 2
-runtime <https://cloud.google.com/appengine/docs/standard/python/>`__,
-use `version 2.2 <https://pypi.org/project/oauth-dropins/2.2/>`__.
-
-If you clone the repo directly or want to contribute, see
-`Development <#development>`__ for setup instructions.
+-  `Available on PyPi. <https://pypi.python.org/pypi/oauth-dropins/>`__
+   Install with ``pip install oauth-dropins``.
+-  `Getting started docs. <#quick-start>`__
+-  `Reference
+   docs. <https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html>`__
+-  Demo app at
+   `oauth-dropins.appspot.com <http://oauth-dropins.appspot.com/>`__.
+-  `Source code on
+   GitHub. <https://github.com/snarfed/oauth-dropins/>`__
 
 This software is released into the public domain. See LICENSE for
 details.
@@ -662,6 +648,8 @@ too <https://github.com/snarfed/granary#release-instructions>`__.)
 Related work
 ------------
 
+-  `Loginpass <https://github.com/authlib/loginpass>`__/`Authlib <https://authlib.org/>`__
+-  `Authomatic <https://authomatic.github.io/authomatic/>`__
 -  `Python Social
    Auth <https://python-social-auth.readthedocs.io/en/latest/>`__
--  `Loginpass <https://github.com/authlib/loginpass>`__/`Authlib <https://authlib.org/>`__
+-  `Authl <https://authl.readthedocs.io/en/stable/>`__

docs/index.rst

@@ -1,11 +1,9 @@
 oauth_dropins
-=============
+-------------
 
 Reference documentation.
 
-.. toctree::
-    oauth_dropins
-
+.. contents::
 
 blogger
 -------

docs/source/oauth_dropins.rst

@@ -1,11 +1,9 @@
-oauth_dropins.webutil
-=============================
+webutil
+-------
 
 Reference documentation.
 
-.. toctree::
-    oauth_dropins.webutil
-
+.. contents::
 
 flask_util
 ----------