From b11f60bf51c6e9e6917767e59b48b7565bf125d5 Mon Sep 17 00:00:00 2001 From: Paul Kienzle Date: Thu, 5 Dec 2024 18:57:35 -0500 Subject: [PATCH] update readthedocs configuration --- .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ doc/sphinx/conf.py | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..f783394 --- /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-22.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/sphinx/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 diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 51f4ac5..df13b15 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -65,7 +65,7 @@ # General information about the project. project = 'Periodic Table' -copyright = '2009, Paul Kienzle' +copyright = '2024, Paul Kienzle' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the