diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..07f013c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-24.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..07084c4 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx-rtd-theme \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 7ef92a6..e34fe7d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -32,7 +32,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'] @@ -57,7 +56,7 @@ # General information about the project. project = 'PyZoltan' -copyright = '2018, PyZoltan Developers' +copyright = '2018-2025, PyZoltan Developers' author = 'PyZoltan Developers' # The version info for the project you're documenting, acts as replacement for @@ -65,16 +64,16 @@ # built documents. # # The short X.Y version. -version = '1.0' +version = '1.1' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '1.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index fa194ad..0000000 --- a/readthedocs.yml +++ /dev/null @@ -1,11 +0,0 @@ -build: - image: latest - -python: - version: 3.6 - setup_py_install: true - -conda: - file: environment.yml - -formats: []