From eae2baece38bb589a1d5d60ec8d923af72c03a27 Mon Sep 17 00:00:00 2001 From: Fabian Jankowski Date: Mon, 7 Aug 2023 14:51:01 +0200 Subject: [PATCH] Switch to the Read the docs sphinx theme. --- README.md | 4 ++-- docs/conf.py | 6 +++--- setup.py | 5 +---- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8f44883..72384a7 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Further documentation of the software is available on our dedicated [Read the do ## Usage ## -``` +```console $ scatfit-fitfrb -h usage: scatfit-fitfrb [-h] [--compare] [--binburst bin] [--fscrunch factor] [--tscrunch factor] [--fast] [--fitrange start end] [--fitscatindex] @@ -84,7 +84,7 @@ options: Zoom into this time region. (default: [-50.0, 50.0]) ``` -``` +```console $ scatfit-simpulse -h usage: scatfit-simpulse [-h] diff --git a/docs/conf.py b/docs/conf.py index 62ffa6b..5d6851e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,10 +15,11 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ + "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.napoleon", - "myst_parser", + "sphinx_rtd_theme", ] myst_enable_extensions = ["dollarmath"] @@ -34,5 +35,4 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "alabaster" -html_static_path = ["_static"] +html_theme = "sphinx_rtd_theme" diff --git a/setup.py b/setup.py index c0128cb..2a4cdc3 100644 --- a/setup.py +++ b/setup.py @@ -63,10 +63,7 @@ def get_long_description(): "pytest-cov", "twine", ], - "docs": [ - "myst-parser", - "sphinx", - ], + "docs": ["myst-parser", "sphinx", "sphinx_rtd_theme"], }, ext_modules=[ Extension(