Skip to content

Commit

Permalink
Fix docs (#53)
Browse files Browse the repository at this point in the history
* Trying to fix readthedocs

* Trying more shit
  • Loading branch information
manthanand authored Dec 2, 2023
1 parent cf21444 commit a9e8b70
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
18 changes: 18 additions & 0 deletions Docs/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 9 additions & 3 deletions Docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'
#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')

0 comments on commit a9e8b70

Please sign in to comment.