diff --git a/.readthedocs.yml b/.readthedocs.yml index 164fb2f..dcb4c93 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,14 +1,27 @@ -# .readthedocs.yml -# Read the Docs configuration file +# Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required version: 2 -# Build from the docs/ directory with Sphinx +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/source/conf.py -# Explicitly set the version of Python and its requirements +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: 3.7 install: - - requirements: docs/source/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt diff --git a/docs/source/requirements.txt b/docs/requirements.txt similarity index 81% rename from docs/source/requirements.txt rename to docs/requirements.txt index 4f3792d..a80a220 100644 --- a/docs/source/requirements.txt +++ b/docs/requirements.txt @@ -10,4 +10,6 @@ pylint pytest lvm_read matplotlib>=3.3 -pyExSi \ No newline at end of file +pyExSi +sphinx-book-theme +sphinx-copybutton \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 20b4680..40325c2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -58,8 +58,7 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The master toctree document. master_doc = 'index' @@ -69,7 +68,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -85,7 +84,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = 'sphinx_book_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