From 71789b1883ac1464077aed585eef06db3d9c7bfe Mon Sep 17 00:00:00 2001 From: DoronHav Date: Thu, 25 Apr 2024 15:16:21 -0400 Subject: [PATCH] fix src conf --- .readthedocs.yaml | 6 ++++-- conf.py | 28 ++++++++++++++++++++++++++++ docs/source/conf.py | 4 +++- 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 conf.py diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e2a4882..e33411f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,12 +9,14 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.12" + python: "3.9" # You can also specify other tool versions: # nodejs: "20" # rust: "1.70" # golang: "1.20" - + jobs: + pre_build: + - sphinx-apidoc ... # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..ca652e0 --- /dev/null +++ b/conf.py @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'wassersteinwormhole' +copyright = '2024, Doron Haviv' +author = 'Doron Haviv' +release = '0.3.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/source/conf.py b/docs/source/conf.py index 3fe9ed3..d19783d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -8,7 +8,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('../../')) + project = 'wassersteinwormhole' copyright = '2024, Doron Haviv' @@ -24,6 +25,7 @@ "sphinx.ext.napoleon", "sphinx_mdinclude", ] + if os.environ.get('READTHEDOCS') == 'True': extensions.append("sphinx_github_style")