fix: change everything back to docs

Signed-off-by: Bryant Finney <[email protected]>

.github/actions/poe/action.yaml

@@ -3,7 +3,7 @@ description: Execute steps to set up the project
 inputs:
   artifacts:
     description: The path to the artifacts to upload
-    default: doc
+    default: docs
 
   poe-task:
     description: Execute this 'poe' task

.github/workflows/push-poe.yaml

@@ -91,13 +91,13 @@ jobs:
 
       - uses: actions/download-artifact@v4
         with:
-          name: lint-doc-py3.12
-          path: doc
+          name: lint-docs-py3.12
+          path: docs
 
       - uses: actions/download-artifact@v4
         with:
-          name: test-doc-py3.12
-          path: doc
+          name: test-docs-py3.12
+          path: docs
 
       - uses: ./.github/actions/poe
         with:
@@ -111,15 +111,15 @@ jobs:
 
       - name: Fix permissions
         run: |
-          chmod -c -R +rX "doc/" | while read -r line; do
+          chmod -c -R +rX "docs/" | while read -r line; do
             echo "::warning title=Invalid file permissions automatically fixed::$line"
           done
 
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
           name: github-pages
-          path: doc
+          path: docs
 
   deploy:
     if: needs.check.outputs.release != 'true'

.gitignore

@@ -19,7 +19,7 @@ reports/
 
 # documentation
 _readthedocs/
-doc/
+docs/
 reports/
 
 # cruft

ptw.ini

@@ -3,8 +3,8 @@ addopts =
     --cov=./src/
     --cov-report=term
     --cov-context=test
-    --cov-report=html:./doc/reports/pytest-html
-    --cov-report=xml:./doc/reports/coverage.xml
+    --cov-report=html:./docs/reports/pytest-html
+    --cov-report=xml:./docs/reports/coverage.xml
     --doctest-modules
-    --junitxml=doc/reports/pytest.xml
+    --junitxml=docs/reports/pytest.xml
     .

pyproject.toml

@@ -490,7 +490,7 @@ evaluation = "max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refact
 # my_package.my_module.MyReporterClass.
 output-format = """\
   colorized,\
-  text:doc/reports/pylint-report.txt\
+  text:docs/reports/pylint-report.txt\
 """
 # Tells whether to display a full report or only the messages.
 reports = "y"
@@ -650,7 +650,7 @@ show_contexts = true
 
 [tool.coverage.xml]
 # https://coverage.readthedocs.io/en/latest/config.html#xml
-output = "doc/reports/coverage.xml"
+output = "docs/reports/coverage.xml"
 
 [tool.pyright]
 # url: https://github.com/microsoft/pyright/blob/main/docs/configuration.md
@@ -688,13 +688,10 @@ help = "Generate this package's docs"
 uses = { PACKAGE_VERSION = "_version" }
 
 [[tool.poe.tasks.docs.sequence]]
-ref = "cargo doc"
+ref = "cargo doc --target-dir ./docs"
 
 [[tool.poe.tasks.docs.sequence]]
-cmd = "cp -r target/doc/ ./doc"
-
-[[tool.poe.tasks.docs.sequence]]
-ref = "docs-serve --output-directory ./doc"
+ref = "docs-serve --output-directory ./docs"
 
 [tool.poe.tasks.docs-serve]
 help = "Launch a local server to view this package's documentation"
@@ -728,12 +725,12 @@ sequence = [
   "pre-commit run --all-files --color always",
   "pylint src",
   """
-  grep -oE 'Your code has been rated at [0-9.]+' doc/reports/pylint-report.txt |
+  grep -oE 'Your code has been rated at [0-9.]+' docs/reports/pylint-report.txt |
     rev | cut -d' ' -f1 | rev |
     xargs -I{} anybadge --overwrite --label pylint --value {} \
-      --file=doc/reports/pylint.svg 7=red 8=orange 9=yellow 10=green
+      --file=docs/reports/pylint.svg 7=red 8=orange 9=yellow 10=green
   """,
-  "safety check --full-report --ignore 70612 --save-html doc/reports",
+  "safety check --full-report --ignore 70612 --save-html docs/reports",
 ]
 
 [tool.poe.tasks.test]
@@ -745,10 +742,10 @@ cmd = """
     --cov-context=test
     --cov-fail-under=90
     --cov-report=term
-    --cov-report=html:./doc/reports/pytest-html
-    --cov-report=xml:./doc/reports/coverage.xml
+    --cov-report=html:./docs/reports/pytest-html
+    --cov-report=xml:./docs/reports/coverage.xml
     --doctest-glob=README.md
-    --junitxml=doc/reports/pytest.xml
+    --junitxml=docs/reports/pytest.xml
     .
 """