doc tools, SECURITY.md updates

GhostofGoes · Aug 23, 2024 · 7603b11 · 7603b11
1 parent aeb4c85
commit 7603b11
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 59 deletions.
diff --git a/SECURITY.md b/SECURITY.md
@@ -4,8 +4,10 @@
 
 | Version    | Supported          |
 | ---------- | ------------------ |
-| 0.8.x      | :white_check_mark: |
-| <= 0.7.x   | :x:                |
+| 1.0.x      | :white_check_mark: Yes |
+| 0.9.x      | :heavy_exclamation_mark: Maintenance mode, security or major bug fixes only |
+| 0.8.x      | :x: No longer supported |               |
+| <= 0.7.x   | :x: No longer supported |
 
 ## Reporting a Vulnerability or other security issue
 

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/TODO.md b/docs/TODO.md
@@ -12,7 +12,7 @@
 - [x] Document `initialize_method_cache()`
 - [ ] Auto-generated API docs
 - [x] Add docstrings to all util methods
-- [ ] Furo, sphinx-autodoc-typehints, sphinx-argparse-cli, sphinx-automodapi, sphinx-copybutton, recommonmark
+- [x] Furo, sphinx-autodoc-typehints, sphinx-argparse-cli, sphinx-automodapi, sphinx-copybutton, recommonmark
 
 ## Tests
 - [ ] Add test to ensure only the expected files make it into the sdist and wheel, no unexpected files
@@ -62,7 +62,7 @@
 
 ## Before releasing
 - [ ] Add a deprecation warning to `get-mac` package, don't publish it for 1.0.0
-- [ ] Update supported versions table in [SECURITY.md](../SECURITY.md)
+- [x] Update supported versions table in [SECURITY.md](../SECURITY.md)
 - [ ] Automate publishing to PyPI+GitHub Release in GitHub Actions
 - [ ] Edit README.md to append CHANGELOG before publishing to PyPI
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -32,13 +32,14 @@
 
 # -- General configuration ---------------------------------------------------
 
-# TODO: sphinx-copybutton
-# TODO: sphinx-tabs (or another extension) to provide tabbed command
-#   examples for different platforms (e.g. for developer docs and CLI usage)
-# TODO(python3): sphinx-autodoc-typehints
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx_autodoc_typehints',
+    'sphinx_inline_tabs',
+    'sphinx_copybutton',
+    'sphinx_argparse_cli',
+    'sphinx_automodapi.automodapi',
 ]
 
 # TODO: setup ReadTheDocs

diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -102,10 +102,11 @@ docs = [
     "furo; python_version >= \"3.9\"",
     "sphinx<7.0.0,>=6.1.3; python_version >= \"3.9\"",
     "recommonmark<1.0.0,>=0.7.1; python_version >= \"3.9\"",
-    "sphinx-autodoc-typehints<2.0.0,>=1.21.8; python_version >= \"3.9\"",
-    "sphinx-copybutton<1.0.0,>=0.5.1; python_version >= \"3.9\"",
-    "sphinx-inline-tabs<2023.0.0,>=2022.1.2b11; python_version >= \"3.9\"",
-    "sphinx-tabs<4.0.0,>=3.4.1; python_version >= \"3.9\"",
+    "sphinx-autodoc-typehints; python_version >= \"3.9\"",
+    "sphinx-copybutton; python_version >= \"3.9\"",
+    "sphinx-inline-tabs; python_version >= \"3.9\"",
+    "sphinx-argparse-cli; python_version >= \"3.9\"",
+    "sphinx-automodapi; python_version >= \"3.9\"",
 ]
 
 [tool.pdm.build]