use uv for docs build (#558)

* use uv for docs build

* remove docs/requirements.txt

Author: gruebel

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ permissions:
 
 env:
   JUST_VERSION: '1'
-  PREK_VERSION: '0.2.11'
+  PREK_VERSION: '0.2.12'
   TERRAFORM_VERSION: '1.13'
 
 jobs:

.readthedocs.yml

@@ -8,15 +8,19 @@ build:
   os: ubuntu-24.04
   tools:
     python: 3.10
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest:0.9
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
 
 mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: false
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
-
-# Optionally set requirements required to build your docs
-python:
-  install:
-    - requirements: docs/requirements.txt

docs/contributing/documentation.md

@@ -15,13 +15,11 @@ Once you've got all that, the rest is simple:
 git clone git@github.com:salesforce/policy_sentry.git
 
 # Set up the virtual environment
-python3 -m venv ./venv && source venv/bin/activate
-uv sync --frozen
-uv pip install -r docs/requirements.txt
+uv sync --frozen --all-groups
 
 # Create the HTML files
-invoke docs.build-docs
-invoke docs.serve-docs
+just build-docs
+just serve-docs
 
 # The above will open the built documentation in your browser
 ```

docs/requirements.txt

@@ -12,11 +12,9 @@ plugins:
       default_handler: python
       handlers:
         python:
-          rendering:
+          options:
             show_source: true
-#            show_if_no_docstring: yes
-      watch:
-        - policy_sentry/
+#            show_if_no_docstring: true
 extra_css:
   - custom.css
 nav:

mkdocs.yml

@@ -54,6 +54,28 @@ dev = [
     "types-requests>=2.32.4",
 ]
 
+docs = [
+    # unique to ReadTheDocs
+    "atomicwrites>=1.4.0,<2.0.0",
+    "distlib>=0.4.0,<0.5.0",
+    "docutils>=0.22.0,<0.23.0",
+    "filelock>=3.20.0,<4.0.0",
+    "mkdocs>=1.6.0,<2.0.0",
+    "mkdocs-material>=9.6.0,<10.0.0",
+    "mkdocs-material-extensions>=1.3.0,<2.0.0",
+    "mkdocstrings>=0.30.0,<0.31.0",
+    "mkdocstrings-python>=1.18.0,<2.0.0",
+    "mkdocstrings-python-legacy>=0.2.0,<0.3.0",
+    "pygments>=2.19.0,<3.0.0",
+    "pymdown-extensions>=10.16.0,<11.0.0",
+    "pytkdocs>=0.16.0,<0.17.0",
+    # Trying to see if RTFD needs these
+    "markdown>=3.9.0,<4.0.0",
+    "markupsafe>=3.0.0,<4.0.0",
+    "jinja2>=3.1.0,<4.0.0",
+    "typed-ast>=1.5.0,<2.0.0",
+]
+
 [build-system]
 # `uv_build` backend doesn't support build hooks yet https://github.com/astral-sh/uv/issues/14561
 requires = ["hatchling"]