Skip to content

Commit f4d7db0

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

4 files changed

Lines changed: 19 additions & 9 deletions

File tree

.readthedocs.yml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,9 @@ build:
77
os: ubuntu-24.04
88
tools:
99
python: "3.13"
10+
jobs:
11+
pre_install:
12+
- pip install mkdocs-material
1013

11-
sphinx:
12-
configuration: docs/conf.py
13-
14-
# Optionally, but recommended,
15-
# declare the Python requirements required to build your documentation
16-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
17-
# python:
18-
# install:
19-
# - requirements: docs/requirements.txt
14+
mkdocs:
15+
configuration: docs/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)