diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..164b9b4 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,36 @@ +# 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" + jobs: + post_checkout: + - git fetch --unshallow || true + +# 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: requirements.d/develop.txt + - method: pip + path: . diff --git a/CHANGES b/CHANGES index d6eb174..fc73b02 100644 --- a/CHANGES +++ b/CHANGES @@ -1,9 +1,8 @@ Changes ======= - -Release 1.0.0 (not released yet) --------------------------------- +Release 1.0.0 (2026-02-08) +-------------------------- Potentially breaking changes: @@ -20,6 +19,8 @@ Fixes: - `Sequence.prune_empty`: fix docstring, #23 - `Dict`: improve exception handling, #6 - suppress Genshi deprecation warnings, #67 +- fix markup generation, reject Tag.open/close for void elements +- fix label 'for' attribute ID generation, #9 Other changes: @@ -34,6 +35,8 @@ Other changes: - convert some docstrings to raw strings - update intersphinx mapping - update i18n, #36 +- fix repository links in docs +- fix readthedocs build, add .readthedocs.yaml Release 0.9.1 (2019-07-26) -------------------------- diff --git a/docs/source/conf.py b/docs/source/conf.py index 983a943..b040df0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,7 +6,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. import sys, os -sys.path.insert(0, os.path.abspath("../..")) +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../../src"))) from flatland._version import version