From 8efd1d56e0c851fedd06ab05099cf3c506f7ab26 Mon Sep 17 00:00:00 2001 From: Ryan Soklaski Date: Sun, 8 Sep 2024 14:39:28 -0400 Subject: [PATCH] docs style --- .readthedocs.yaml | 29 ----------------------------- docs/source/conf.py | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 29 deletions(-) delete mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 0e7b66df..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,29 +0,0 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - - -# Required -version: 2 - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/source/conf.py - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml - -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - - -build: - os: ubuntu-22.04 - tools: - python: "3.11" - -# Explicitly set the version of Python and its requirements -python: - install: - - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index ec0d1623..9460ab0f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -99,6 +99,20 @@ # html_theme = "pydata_sphinx_theme" +html_theme_options = { + "collapse_navigation": True, + "navigation_depth": 4, + "pygment_light_style": "default", + "pygment_dark_style": "zenburn", + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/rsokl/MyGrad", + "icon": "fab fa-github-square", + }, + ], +} + def setup(app): app.add_css_file("my_theme.css")