fix docs build and docs around standards, towncrier, etc. (#337)

* fix docs build and docs around standards, towncrier, etc.

* update ci 'needs' clauses

* update to remove mypy

* fix mkdocs with more docs best practices

* fix mkdocs with more docs best practices

* fix griffe types for auto docs adn add code references to mkdocs

* fix yamllint

* fix yamllint

* fix rest of test

* add unittest for release notes and docs versions, fix docs requireemnts.txt

Author: jeffkala

.github/workflows/ci.yml

@@ -70,6 +70,10 @@ jobs:
           poetry-version: "1.8.5"
       - name: "Checking: poetry lock file"
         run: "poetry lock --check"
+    needs:
+      - "ruff-format"
+      - "ruff-lint"
+      - "yamllint"
   yamllint:
     runs-on: "ubuntu-24.04"
     env:
@@ -83,6 +87,9 @@ jobs:
           poetry-version: "1.8.5"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
+    needs:
+      - "ruff-format"
+      - "ruff-lint"
   pylint:
     runs-on: "ubuntu-24.04"
     strategy:
@@ -118,6 +125,8 @@ jobs:
         run: "docker image ls"
       - name: "Linting: Pylint"
         run: "poetry run invoke pylint"
+    needs:
+      - "poetry"
   pytest:
     strategy:
       fail-fast: true
@@ -153,6 +162,8 @@ jobs:
         run: "docker image ls"
       - name: "Run Tests"
         run: "poetry run invoke pytest"
+    needs:
+      - "poetry"
   publish_gh:
     name: "Publish to GitHub"
     runs-on: "ubuntu-24.04"

docs/admin/install.md

@@ -2,21 +2,21 @@
 
 Option 1: Install from PyPI.
 
-```
+```bash
 pip install pyntc
 ```
 
 Option 2: Manually install via Poetry.
 
-```
+```bash
 git clone https://github.com/networktocode/pyntc.git
 cd pyntc
-pip install poetry
+curl -sSL https://install.python-poetry.org | python3 -
 poetry install
 ```
 
 Option 3: Install from a GitHub branch, such as develop as shown below.
 
 ```bash
-$ pip install git+https://github.com/networktocode/pyntc.git@develop
+pip install git+https://github.com/networktocode/pyntc.git@develop
 ```