docs

Author: afuetterer

.github/workflows/documentation.yml

@@ -4,7 +4,7 @@ name: Generate and deploy documentation
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main", "master", "add-automated-documentation"]
+    branches: ["master"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -29,11 +29,11 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v6
+      - run: pip --version
       - name: Install dependencies
         run: |
-          pip install sphinx furo myst-parser
+          pip install . --group=docs
       - name: Sphinx APIDoc
         run: |
           sphinx-apidoc -f -o docs/source/ .
@@ -43,7 +43,7 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           # Upload entire repository
           path: './docs/build/html'

.gitignore

@@ -12,3 +12,4 @@
 .idea
 __pycache__/
 .coverage
+docs/build

docs/source/conf.py

@@ -5,14 +5,9 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-import os
-import sys
-
-# Add the parent directory of the documentation root to sys.path
-sys.path.insert(0, os.path.abspath("../.."))
 
 project = 'tika-python'
-copyright = '2024, Chris A. Mattmann'
+copyright = '2026, Chris A. Mattmann'
 author = 'Chris A. Mattmann'
 
 # -- General configuration ---------------------------------------------------
@@ -26,16 +21,13 @@
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.todo",
     "sphinx.ext.duration",
-    "myst_parser"
+    "myst_parser",
 ]
 
-templates_path = ['_templates']
-exclude_patterns = ['tika.tests*']
-
-
+exclude_patterns = ['_build']
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'furo'
-html_static_path = ['_static']
+

docs/source/index.md

@@ -0,0 +1,15 @@
+# Welcome to tika-python's documentation!
+
+```{toctree}
+:maxdepth: 7
+:caption: Contents
+readme.md
+tika.md
+```
+
+## Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+- {ref}`search`
+

docs/source/index.rst

@@ -34,15 +34,17 @@ dependencies = [
   "requests",
 ]
 
-[project.optional-dependencies]
-all = [
-  "tika[tests]",
-]
-tests = [
+[dependency-groups]
+test = [
   "memory-profiler",
   "pytest-benchmark",
   "pytest-cov",
 ]
+docs = [
+  "furo",
+  "myst-parser",
+  "sphinx",
+]
 
 [project.urls]
 homepage = "http://github.com/chrismattmann/tika-python"