Skip to content

fix readthedocs build #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
orbeckst wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix readthedocs build #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
493ca78
updated readthedocs config
orbeckst Jul 23, 2026
04d199f
removed failing example from pydantic example file
orbeckst Jul 23, 2026
e9ea575
increase sphinx version to >= 7.2.0
orbeckst Jul 23, 2026
5646a95
removed myst-parser pin from RTD conda env
orbeckst Jul 23, 2026
e1838ee
Merge branch 'main' into update-rtd
orbeckst Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The rules for this file:
<!-- GitHub usernames of contributors to this release -->
- IAlibay
- lilyminium
- orbeckst

### Reviewers
<!-- GitHub usernames of reviewers of this release -->
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 2 additions & 8 deletions docs/pydantic_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from pydantic import BaseSettings, Field, validator
from pydantic import Field, validator
from pydantic_settings import BaseSettings


class ExampleSettings(BaseSettings):
Expand All @@ -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."
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down