From a9e8b700c7b407f74cd05ce0165095b8ed931d40 Mon Sep 17 00:00:00 2001 From: Manthan Upadhyaya <55002301+manthanand@users.noreply.github.com> Date: Sat, 2 Dec 2023 12:38:42 -0600 Subject: [PATCH] Fix docs (#53) * Trying to fix readthedocs * Trying more shit --- Docs/.readthedocs.yaml | 18 ++++++++++++++++++ Docs/source/conf.py | 12 +++++++++--- 2 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 Docs/.readthedocs.yaml diff --git a/Docs/.readthedocs.yaml b/Docs/.readthedocs.yaml new file mode 100644 index 0000000..8c79b01 --- /dev/null +++ b/Docs/.readthedocs.yaml @@ -0,0 +1,18 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details (copied from here, with changes) + +# 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 +formats: + - pdf diff --git a/Docs/source/conf.py b/Docs/source/conf.py index e38fdbd..73dcef3 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -25,7 +25,6 @@ # The full version, including alpha/beta/rc tags release = '0.0' - # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be @@ -58,5 +57,12 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -# use index.rst -master_doc = 'index' \ No newline at end of file +#Ignore warnings for duplicate labels since we use the same label for multiple sections +#This means that if you are trying to refer to a label, it might not be possible +suppress_warnings = ['autosectionlabel.*'] + +#use index.rst +master_doc = 'index' + +def setup(app): + app.add_css_file('my_theme.css') \ No newline at end of file