From 72574dd8a6f2d6183b613313cdee2c47d59ca97a Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Thu, 9 Feb 2023 17:21:13 +0100 Subject: [PATCH] Make some modifications to docs config --- docs/source/conf.py | 11 +++++------ docs/source/index.rst | 5 +++++ docs/source/requirements.txt | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 19ed3014..31494e79 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,9 +1,6 @@ # # Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config +# Documentation: http://www.sphinx-doc.org/en/master/config # # -- Imports ----------------------------------------------------------------- @@ -38,14 +35,13 @@ os.environ["TZ"] = "Europe/Oslo" time.tzset() needs_sphinx = "4.0" +extensions = [] templates_path = ["_templates"] source_suffix = ".rst" master_doc = "index" today_fmt = "%A, %d %B %Y at %H:%M" language = "en" exclude_patterns = [] -pygments_style = "sphinx" -pygments_dark_style = "monokai" # -- Options for HTML Output ------------------------------------------------- @@ -54,8 +50,11 @@ html_static_path = ["_static"] html_theme_options = { "light_logo": "novelwriter-light.png", "dark_logo": "novelwriter-dark.png", + "navigation_with_keys": True, } html_title = f"
Documentation Version {release}
" +pygments_style = "tango" +pygments_dark_style = "native" # -- Options for HTMLHelp Output --------------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 55df2c4d..9c052a33 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -47,6 +47,11 @@ the pip tool. See :ref:`a_started` for more details. * PyPi Project: https://pypi.org/project/novelWriter * Social Media: https://fosstodon.org/@novelwriter +.. toctree:: + :hidden: + + Main Page + .. toctree:: :maxdepth: 1 :caption: Introduction diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 777d09c0..1896078f 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,4 +1,4 @@ furo sphinx>=4.0 pygments>=2.7 -docutils==0.17.1 +docutils>=0.17.1