Skip to content

Commit c46a109

Browse files
committed
Create readthedocs documentation
1 parent 928f6f1 commit c46a109

5 files changed

Lines changed: 29 additions & 19 deletions

File tree

.readthedocs.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/.readthedocs.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-24.04
8+
tools:
9+
python: "3.13"
10+
jobs:
11+
pre_install:
12+
- pip install mkdocs-material
13+
14+
mkdocs:
15+
configuration: mkdocs.yml

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Hello world!

docs/js/readthedocs-search.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
document.addEventListener("DOMContentLoaded", function(event) {
2+
document.querySelector(".md-search__input").addEventListener("focus", (e) => {
3+
const event = new CustomEvent("readthedocs-search-show");
4+
document.dispatchEvent(event);
5+
});
6+
});

docs/mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
site_name: PHP Parallel Processes
2+
theme:
3+
name: material
4+
site_url: !ENV READTHEDOCS_CANONICAL_URL
5+
extra_javascript:
6+
- js/readthedocs-search.js
7+
docs_dir: .

0 commit comments

Comments
 (0)