docs: initialize documentation (#178)

.github/workflows/docs.yaml

@@ -0,0 +1,29 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [released]
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+    - name: Ape Docs
+      uses: apeworx/sphinx-ape@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -32,6 +32,34 @@ pre-commit install
 
 Committing will now automatically run the local hooks and ensure that your commit passes all lint checks.
 
+## Running the docs locally
+
+First, make sure you have the docs-related tooling installed:
+
+```bash
+pip install -e .'[doc]'
+```
+
+Then, run the following from the root project directory:
+
+```bash
+sphinx-ape build .
+```
+
+For the best viewing experience, use a local server:
+
+```bash
+sphinx-ape serve .
+```
+
+Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link.
+
+You can also use the `--open` flag to automatically open the docs:
+
+```bash
+sphinx-ape serve . --open
+```
+
 ## Pull Requests
 
 Pull requests are welcomed! Please adhere to the following:

docs/conf.py

@@ -0,0 +1 @@
+extensions = ["sphinx_ape"]

docs/index.rst

@@ -0,0 +1 @@
+.. dynamic-toc-tree::

docs/userguides/quickstart.md

@@ -0,0 +1,2 @@
+```{include} ../../README.md
+```

setup.py

@@ -28,14 +28,7 @@
         "mdformat-frontmatter>=0.4.1",  # Needed for frontmatters-style headers in issue templates
         "mdformat-pyproject>=0.0.1",  # Allows configuring in pyproject.toml
     ],
-    "doc": [
-        "myst-parser>=1.0.0,<2",  # Parse markdown docs
-        "sphinx-click>=4.4.0,<5",  # For documenting CLI
-        "Sphinx>=6.1.3,<7",  # Documentation generator
-        "sphinx_rtd_theme>=1.2.0,<2",  # Readthedocs.org theme
-        "sphinxcontrib-napoleon>=0.7",  # Allow Google-style documentation
-        "sphinx-plausible>=0.1.2,<0.2",
-    ],
+    "doc": ["sphinx-ape @ git+ssh://[email protected]/ApeWorX/sphinx-ape@feat/actionable"],
     "release": [  # `release` GitHub Action job uses this
         "setuptools",  # Installation tool
         "setuptools-scm",  # Installation tool