Skip to content

Commit

Permalink
Relax Sphinx 5 requirement
Browse files Browse the repository at this point in the history
No restricting the version will help the migration in documenteer; where
old-style technotes may be using and are tested with older Sphinx versions.
  • Loading branch information
jonathansick committed Nov 30, 2022
1 parent 19fdfd2 commit af2ee45
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@
# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
name = "technote"
description = "Rubin Observatory's framework for Sphinx-based technote documents."
license = {file = "LICENSE"}
readme= "README.md"
keywords = [
"rubin",
"lsst",
]
license = { file = "LICENSE" }
readme = "README.md"
keywords = ["rubin", "lsst"]
# https://pypi.org/classifiers/
classifiers = [
"Development Status :: 4 - Beta",
Expand All @@ -24,7 +21,7 @@ classifiers = [
]
requires-python = ">=3.8"
dependencies = [
"Sphinx>=5.0.0",
"Sphinx",
"sphinx-basic-ng>=1.0.0b1",
"base32-lib",
"tomli; python_version < \"3.11\"",
Expand All @@ -47,7 +44,7 @@ dev = [
"cssselect",
# Documentation
"documenteer[guide]",
"autodoc_pydantic"
"autodoc_pydantic",
]

[project.urls]
Expand All @@ -58,11 +55,7 @@ Source = "https://github.com/lsst-sqre/technote"
technote = "technote"

[build-system]
requires = [
"setuptools>=61",
"wheel",
"setuptools_scm[toml]>=6.2"
]
requires = ["setuptools>=61", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
Expand Down Expand Up @@ -92,7 +85,7 @@ exclude_lines = [
"raise NotImplementedError",
"if 0:",
"if __name__ == .__main__.:",
"if TYPE_CHECKING:"
"if TYPE_CHECKING:",
]

[tool.black]
Expand All @@ -117,7 +110,7 @@ exclude = '''
# Reference: http://www.pydocstyle.org/en/stable/error_codes.html
convention = "numpy"
add_select = [
"D212" # Multi-line docstring summary should start at the first line
"D212", # Multi-line docstring summary should start at the first line
]
add-ignore = [
"D105", # Missing docstring in magic method
Expand All @@ -140,10 +133,7 @@ skip = ["docs/conf.py"]

[tool.pytest.ini_options]
asyncio_mode = "strict"
python_files = [
"tests/*.py",
"tests/*/*.py"
]
python_files = ["tests/*.py", "tests/*/*.py"]

[tool.mypy]
disallow_untyped_defs = true
Expand All @@ -154,6 +144,6 @@ warn_redundant_casts = true
warn_unreachable = true
warn_unused_ignores = true
exclude = [
"tests/roots" # ignore conf.py files from test cases
"tests/roots", # ignore conf.py files from test cases
]
# plugins =

0 comments on commit af2ee45

Please sign in to comment.