Merge pull request #94 from pacrob/change-doc-to-docs

change references to doc to all be docs

.readthedocs.yml

@@ -13,4 +13,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - doc
+        - docs

docs/conf.py

@@ -190,7 +190,7 @@ html_theme = "sphinx_rtd_theme"
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "<MODULE_NAME>doc"
+htmlhelp_basename = "<MODULE_NAME>docs"
 
 
 # -- Options for LaTeX output ---------------------------------------------

newsfragments/README.md

@@ -11,7 +11,7 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
 * `breaking`
 * `bugfix`
 * `deprecation`
-* `doc`
+* `docs`
 * `feature`
 * `internal`
 * `misc`

newsfragments/validate_files.py

@@ -10,7 +10,7 @@ ALLOWED_EXTENSIONS = {
     ".breaking.rst",
     ".bugfix.rst",
     ".deprecation.rst",
-    ".doc.rst",
+    ".docs.rst",
     ".feature.rst",
     ".internal.rst",
     ".misc.rst",

pyproject.toml

@@ -23,7 +23,7 @@ name = "Deprecations"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "doc"
+directory = "docs"
 name = "Improved Documentation"
 showcontent = true
 

setup.py

@@ -18,7 +18,7 @@ extras_require = {
         "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["dev"]
     + extras_require["test"]
     + extras_require["lint"]
-    + extras_require["doc"]
+    + extras_require["docs"]
 )
 
 

tox.ini

@@ -34,7 +34,7 @@ basepython=
     py311: python3.11
 extras=
     test
-    docs: doc
+    docs
 allowlist_externals=make
 
 [common-lint]