Merge pull request #218 from fls-bioinformatics-core/readthedocs-fixe…

…s-and-updates Documentation fixes and updates for ReadTheDocs
fls-bioinformatics-core · Feb 16, 2024 · c8de134 · c8de134
2 parents 07d073c + 1cb8a16
commit c8de134
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - requirements: requirements.txt
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx==7.1.2
+sphinx_rtd_theme==2.0.0
+readthedocs-sphinx-search==0.3.2
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,7 +26,8 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = ['sphinx_rtd_theme',
+              'sphinx.ext.autodoc',
               'sphinx.ext.napoleon',
               'sphinx.ext.intersphinx',]
 
@@ -97,7 +98,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+xlwt>=0.7.2
+xlrd>=0.7.1
+xlutils>=1.4.1
+xlsxwriter>=0.8.4