Add mkdocs configuration

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@ba3bb36eb2066252b2363392b7739741bb777659
+        with:
+          environments: docs
+      - name: Build docs
+        run: pixi run -e docs docs-build
+      - name: Deploy docs
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: pixi run -e docs mkdocs gh-deploy --force

README.md

@@ -1,6 +1,7 @@
 # multiregex
 
 [![CI](https://img.shields.io/github/actions/workflow/status/quantco/multiregex/ci.yml?style=flat-square&branch=main)](https://github.com/quantco/multiregex/actions/workflows/ci.yml)
+[![Documentation](https://img.shields.io/badge/docs-7E56C2?style=flat-square)](https://quantco.github.io/multiregex)
 [![conda-forge](https://img.shields.io/conda/vn/conda-forge/multiregex?logoColor=white&logo=conda-forge&style=flat-square)](https://prefix.dev/channels/conda-forge/packages/multiregex)
 [![pypi-version](https://img.shields.io/pypi/v/multiregex.svg?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/multiregex)
 [![python-version](https://img.shields.io/pypi/pyversions/multiregex?logoColor=white&logo=python&style=flat-square)](https://pypi.org/project/multiregex)

docs/api-documentation.md

@@ -0,0 +1,3 @@
+# API Documentation
+
+::: multiregex

docs/index.md

@@ -0,0 +1,19 @@
+# multiregex
+
+Quickly match many regexes against a string. Provides 2-10x speedups over naïve regex matching.
+
+You can also link to code in the auto-generated API documentation:
+
+<!-- Lengthy version -->
+
+See our fancy [`get_pattern_candidates`](api-documentation/#multiregex.RegexMatcher.get_pattern_candidates) method.
+
+<!--
+    Shorthand "Cross-references":
+    https://mkdocstrings.github.io/usage/#cross-references
+    Note the [][] syntax!
+-->
+
+In case you forgot to check the [`get_pattern_candidates`][multiregex.RegexMatcher.get_pattern_candidates] method!
+
+[API Documentation](api-documentation.md)

docs/styles/custom.css

@@ -0,0 +1,7 @@
+/*
+Allows to highlight the specific entry that is jumped to when clicking on an internal link.
+*/
+:target {
+    border: 1px solid red;
+    border-radius: 5px;
+}

mkdocs.yml

@@ -0,0 +1,63 @@
+site_name: multiregex
+site_description: Quickly match many regexes against a string. Provides 2-10x speedups over naïve regex matching.
+site_url: https://quantco.github.io/multiregex
+theme:
+  name: material
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+      primary: deep purple
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+      primary: deep purple
+  features:
+    - content.action.edit
+    - search.suggest
+    - search.highlight
+    - content.code.annotate
+    - content.code.copy
+  icon:
+    repo: fontawesome/brands/github-alt
+    edit: material/pencil
+
+# For the optional feature of highlighting selected element after jumping to it
+extra_css:
+  - styles/custom.css
+
+repo_name: quantco/multiregex
+repo_url: https://github.com/quantco/multiregex
+edit_uri: edit/main/docs/
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            unwrap_annotated: true
+            show_symbol_type_heading: true
+            docstring_style: numpy
+            docstring_section_style: spacy
+            separate_signature: true
+            merge_init_into_class: true
+
+nav:
+  - index.md
+  - api-documentation.md
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.inlinehilite