Switches to read-the-docs theme for docs.

seantis · Aug 27, 2024 · c14ebf7 · c14ebf7
1 parent 7bb79b3
commit c14ebf7
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 38 deletions.
diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@ An Ansible API for humans.
 Documentation
 -------------
 
-`<http://suitable.readthedocs.org>`_
+`<https://seantis.github.io/suitable/>`_
 
 Warning
 -------

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
diff --git a/docs/conf.py b/docs/conf.py
@@ -113,17 +113,13 @@
 
 # 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'
 
 html_theme_options = {
-    'logo': 'logo.svg',
-    'github_user': 'seantis',
-    'github_repo': 'suitable',
-    'github_type': 'star',
-    'travis_button': False,
-    'codecov_button': True
+    'logo_only': True,
 }
-html_style = 'custom.css'
+html_logo = '_static/logo.svg'
+#html_style = 'custom.css'
 
 # 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,
@@ -214,7 +210,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'Suitable.tex', 'Suitable Documentation',
-     u'Denis Krienbühl', 'manual'),
+     'Denis Krienbühl', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx
-sphinxcontrib.autodoc-inherit-overload
+sphinxcontrib.autodoc-inherit-overload
+sphinx-rtd-theme