diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9986983..f85bd3b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,9 +5,9 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: - python: "mambaforge-4.10" + python: "miniforge3-latest" python: install: diff --git a/CHANGELOG.md b/CHANGELOG.md index cfd1369..0d2bce7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ The rules for this file: - IAlibay - lilyminium +- orbeckst ### Reviewers @@ -37,6 +38,7 @@ The rules for this file: - always add bullet for unordered list (#82) ### Changed +- Bumped minimum required sphinx to 7.2.0 (#75, PR #100) - Modernized packaging to be PEP518 compliant. ### Removed diff --git a/docs/environment.yml b/docs/environment.yml index 3378ccc..0761f94 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -14,11 +14,11 @@ dependencies: - nbconvert - ipykernel - autodoc-pydantic - - myst-parser~=1.0 + - myst-parser - pandoc - wheel - sphinx-autobuild - - sphinx>=6.2.1 + - sphinx>=7.2.0 - sphinx_rtd_theme - mdanalysis diff --git a/docs/pydantic_example.py b/docs/pydantic_example.py index 80b0e93..1004b2f 100644 --- a/docs/pydantic_example.py +++ b/docs/pydantic_example.py @@ -1,4 +1,5 @@ -from pydantic import BaseSettings, Field, validator +from pydantic import Field, validator +from pydantic_settings import BaseSettings class ExampleSettings(BaseSettings): @@ -10,16 +11,9 @@ class ExampleSettings(BaseSettings): field_plain_with_validator: int = 100 """Show standard field with type annotation.""" - field_plain = 100 - """Show standard field without type annotation.""" - field_with_validator_and_alias: str = Field("FooBar", alias="BarFoo", env="BarFoo") """Shows corresponding validator with link/anchor.""" - field_with_validator_and_alias_typeless = Field( - "FooBar", alias="BarFoo", env="BarFoo" - ) - """Shows corresponding validator with link/anchor but without type annotation.""" field_with_constraints_and_description: int = Field( default=5, ge=0, le=100, description="Shows constraints within doc string." diff --git a/pyproject.toml b/pyproject.toml index 57511f5..a5fb3f7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ readme = {file = "README.md", content-type = "text/markdown"} requires-python = ">=3.9" dependencies = [ "sphinx_rtd_theme>=1.3", - "sphinx>=6.2.1", + "sphinx>=7.2.0", "beautifulsoup4", "python-slugify[unidecode]", "css_html_js_minify",