From 356b1a31716b15e59ba657e8180f8ef1080867af Mon Sep 17 00:00:00 2001 From: bxdd Date: Wed, 22 Nov 2023 15:31:27 +0800 Subject: [PATCH 1/2] [MNT] update doc style --- docs/_static/css/custom_style.css | 2 +- docs/conf.py | 23 +++-------------------- 2 files changed, 4 insertions(+), 21 deletions(-) diff --git a/docs/_static/css/custom_style.css b/docs/_static/css/custom_style.css index 00a18c9..579fe07 100644 --- a/docs/_static/css/custom_style.css +++ b/docs/_static/css/custom_style.css @@ -1,3 +1,3 @@ .wy-nav-content { - max-width: 1200px !important; + max-width: none; } \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index e47ca81..f0760ba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,5 @@ import pkg_resources -import sphinx_rtd_theme +import sphinx_book_theme # Configuration file for the Sphinx documentation builder. # @@ -90,12 +90,10 @@ todo_include_todos = True # 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_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme = "sphinx_book_theme" +html_theme_path = [sphinx_book_theme.get_html_theme_path()] html_theme_options = { - "logo_only": True, "collapse_navigation": False, - "display_version": False, "navigation_depth": 4, } @@ -111,21 +109,6 @@ html_css_files = [ 'css/custom_style.css', ] -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - "**": [ - "about.html", - "navigation.html", - "relations.html", # needs 'show_related': True theme option to display - "searchbox.html", - ] -} - - # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. From f2ce8c4c94ce3e884ef5b07df685526056fba54d Mon Sep 17 00:00:00 2001 From: bxdd Date: Wed, 22 Nov 2023 15:32:58 +0800 Subject: [PATCH 2/2] [MNT] update setup --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index ebf8e99..ad35bb4 100644 --- a/setup.py +++ b/setup.py @@ -57,7 +57,7 @@ REQUIRED = [ DEV_REQUIRED = [ # For documentations "sphinx", - "sphinx_rtd_theme", + "sphinx_book_theme", # CI dependencies "pytest>=3", "wheel",