From 23a192f62c6ad5bff2beb54284652c215971dfa6 Mon Sep 17 00:00:00 2001 From: pacrob Date: Wed, 3 May 2023 14:05:29 -0600 Subject: [PATCH] change references to doc to all be docs --- .readthedocs.yml | 2 +- docs/conf.py | 2 +- newsfragments/README.md | 2 +- newsfragments/validate_files.py | 2 +- pyproject.toml | 2 +- setup.py | 4 ++-- tox.ini | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index bb96642a..50b9b384 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,4 +13,4 @@ python: - method: pip path: . extra_requirements: - - doc + - docs diff --git a/docs/conf.py b/docs/conf.py index db3f3492..1d0560df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -190,7 +190,7 @@ # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = "doc" +htmlhelp_basename = "docs" # -- Options for LaTeX output --------------------------------------------- diff --git a/newsfragments/README.md b/newsfragments/README.md index 2ef923e8..7c8981fa 100644 --- a/newsfragments/README.md +++ b/newsfragments/README.md @@ -11,7 +11,7 @@ Each file should be named like `..rst`, where * `breaking` * `bugfix` * `deprecation` -* `doc` +* `docs` * `feature` * `internal` * `misc` diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py index edd5e050..bc68bfe5 100755 --- a/newsfragments/validate_files.py +++ b/newsfragments/validate_files.py @@ -10,7 +10,7 @@ ".breaking.rst", ".bugfix.rst", ".deprecation.rst", - ".doc.rst", + ".docs.rst", ".feature.rst", ".internal.rst", ".misc.rst", diff --git a/pyproject.toml b/pyproject.toml index aa7ddcd0..d94ebfd9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,7 +23,7 @@ name = "Deprecations" showcontent = true [[tool.towncrier.type]] -directory = "doc" +directory = "docs" name = "Improved Documentation" showcontent = true diff --git a/setup.py b/setup.py index dc1a39f1..859008ec 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ "pydocstyle>=6.0.0", "black>=23", ], - "doc": [ + "docs": [ "sphinx>=6.0.0", "sphinx_rtd_theme>=1.0.0", "towncrier>=21,<22", @@ -38,7 +38,7 @@ extras_require["dev"] + extras_require["test"] + extras_require["lint"] - + extras_require["doc"] + + extras_require["docs"] ) diff --git a/tox.ini b/tox.ini index 35503e26..b1dae72a 100644 --- a/tox.ini +++ b/tox.ini @@ -34,7 +34,7 @@ basepython= py311: python3.11 extras= test - docs: doc + docs allowlist_externals=make [common-lint]