From b90c4d7a6143d1bf0a4cdccfae9ac04e0c3f3eea Mon Sep 17 00:00:00 2001 From: Paco Hope Date: Tue, 9 Aug 2022 19:55:04 -0400 Subject: [PATCH] Updated styles and theme options --- docs/requirements.txt | 1 + docs/source/conf.py | 13 +++++++++++-- docs/source/index.rst | 9 ++++----- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 56f5ee7..424f542 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ sphinx sphinx-argparse +alabaster diff --git a/docs/source/conf.py b/docs/source/conf.py index 5684a75..41448ce 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,6 +2,10 @@ # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import alabaster + +html_theme_path = [alabaster.get_path()] +html_theme = 'alabaster' project = 'TFScript' copyright = '2022, Nicholas Hope and Paco Hope' @@ -12,11 +16,16 @@ extensions = [ 'sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', - 'sphinxarg.ext' ] + 'sphinxarg.ext', + 'alabaster' ] templates_path = ['_templates'] exclude_patterns = [] -html_theme = 'alabaster' html_static_path = ['_static'] +html_theme_options = { + 'description' : "Managing and simplifying TF2 scripts.", + 'fixed_sidebar' : True, + 'show_powered_by' : False, +} import os import sys diff --git a/docs/source/index.rst b/docs/source/index.rst index 61e1e39..9dd8fad 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,9 +4,8 @@ Welcome to TFScript TFScript helps you manage all the customisations you make to your Team Fortress 2 configurations. If you have `custom scripts `_ in your ``cfg`` files, then this will help you automate that. - .. toctree:: - :maxdepth: 1 - - cli - installing \ No newline at end of file + :hidden: + :glob: + + * \ No newline at end of file