From 3cc44301aeb781cfb5fbe08a53d7cdf61ab41519 Mon Sep 17 00:00:00 2001 From: Matthew Scott Date: Thu, 27 Feb 2025 22:08:04 -0600 Subject: [PATCH] Fix doc generation --- .readthedocs.yml | 7 ++++--- docs/.gitignore | 1 + docs/conf.py | 2 +- pyproject.toml | 12 ++++++------ uv.lock | 28 +++++++++++++--------------- 5 files changed, 25 insertions(+), 25 deletions(-) create mode 100644 docs/.gitignore diff --git a/.readthedocs.yml b/.readthedocs.yml index 79e37e8..07e8bbc 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,13 +1,14 @@ version: 2 -build: - image: testing sphinx: configuration: docs/conf.py formats: [] python: - version: 3.9 install: - method: pip path: . extra_requirements: - docs +build: + os: ubuntu-lts-latest + tools: + python: "3.13" diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..1936cc1 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +html diff --git a/docs/conf.py b/docs/conf.py index 90e9ad0..74af1fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -300,4 +300,4 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {"https://docs.python.org/": None} +# intersphinx_mapping = {"https://docs.python.org/": None} diff --git a/pyproject.toml b/pyproject.toml index 66bfc10..5b7f752 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,6 +15,12 @@ repository = "https://github.com/metrasynth/sunvox-dll-python" buffered = [ "numpy>=2.0.2", ] +docs = [ + "plantweb>=1.3.0", + "radiant-voices>=1.0.3", + "sphinx>=7.4.7", + "sphinx-rtd-theme>=3.0.2", +] tools = [ "numpy>=2.0.2", "scipy>=1.13.1", @@ -33,12 +39,6 @@ dev = [ "pytest>=8.3.4", "pytest-watch>=4.2.0", ] -docs = [ - "plantweb>=1.3.0", - "radiant-voices>=1.0.3", - "sphinx>=7.4.7", - "sphinx-rtd-theme>=3.0.2", -] [tool.pytest.ini_options] addopts = "--doctest-glob='*.rst' --doctest-modules" diff --git a/uv.lock b/uv.lock index 6009e2b..ee5fa2b 100644 --- a/uv.lock +++ b/uv.lock @@ -1004,6 +1004,14 @@ buffered = [ { name = "numpy", version = "2.0.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, { name = "numpy", version = "2.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" }, ] +docs = [ + { name = "plantweb" }, + { name = "radiant-voices" }, + { name = "sphinx", version = "7.4.7", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, + { name = "sphinx", version = "8.1.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version == '3.10.*'" }, + { name = "sphinx", version = "8.2.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, + { name = "sphinx-rtd-theme" }, +] tools = [ { name = "numpy", version = "2.0.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, { name = "numpy", version = "2.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" }, @@ -1017,35 +1025,25 @@ dev = [ { name = "pytest" }, { name = "pytest-watch" }, ] -docs = [ - { name = "plantweb" }, - { name = "radiant-voices" }, - { name = "sphinx", version = "7.4.7", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, - { name = "sphinx", version = "8.1.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version == '3.10.*'" }, - { name = "sphinx", version = "8.2.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, - { name = "sphinx-rtd-theme" }, -] [package.metadata] requires-dist = [ { name = "numpy", marker = "extra == 'buffered'", specifier = ">=2.0.2" }, { name = "numpy", marker = "extra == 'tools'", specifier = ">=2.0.2" }, + { name = "plantweb", marker = "extra == 'docs'", specifier = ">=1.3.0" }, + { name = "radiant-voices", marker = "extra == 'docs'", specifier = ">=1.0.3" }, { name = "scipy", marker = "extra == 'tools'", specifier = ">=1.13.1" }, + { name = "sphinx", marker = "extra == 'docs'", specifier = ">=7.4.7" }, + { name = "sphinx-rtd-theme", marker = "extra == 'docs'", specifier = ">=3.0.2" }, { name = "tqdm", marker = "extra == 'tools'", specifier = ">=4.67.1" }, ] -provides-extras = ["buffered", "tools"] +provides-extras = ["buffered", "docs", "tools"] [package.metadata.requires-dev] dev = [ { name = "pytest", specifier = ">=8.3.4" }, { name = "pytest-watch", specifier = ">=4.2.0" }, ] -docs = [ - { name = "plantweb", specifier = ">=1.3.0" }, - { name = "radiant-voices", specifier = ">=1.0.3" }, - { name = "sphinx", specifier = ">=7.4.7" }, - { name = "sphinx-rtd-theme", specifier = ">=3.0.2" }, -] [[package]] name = "tomli"