doc: Declare using platformdirs

attakei · Apr 28, 2024 · 797c1fe · 797c1fe
1 parent d6443fc
commit 797c1fe
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -5,6 +5,7 @@
 
 extensions = [
     "oembedpy.ext.sphinx",
+    "rst_package_refs.sphinx",
     "sphinx.ext.autodoc",
 ]
 templates_path = ["_templates"]

diff --git a/docs/index.rst b/docs/index.rst
@@ -26,6 +26,7 @@ Included features
    :caption: Contents:
 
    commandline
+   workspace
    integrations/sphinx
    api
    changelogs
diff --git a/docs/workspace.rst b/docs/workspace.rst
@@ -0,0 +1,7 @@
+=========
+Workspace
+=========
+
+oEmbedPy uses user local directory to management configuration and cache.
+
+.. note:: Refer to :pypi:`platformdirs`
diff --git a/pyproject.toml b/pyproject.toml
@@ -27,6 +27,7 @@ dependencies = [
   "beautifulsoup4",
   "httpx",
   "lxml",
+  "platformdirs",
 ]
 dynamic = ["version", "description"]
 
@@ -35,6 +36,7 @@ cli = ["Click>=8"]
 doc = [
   "furo",
   "Sphinx",
+  "rst-package-refs",
 ]
 sphinx = [
   "sphinx",