Create readthedocs documentation

Author: steevanb

.readthedocs.yml

@@ -7,6 +7,7 @@
 - Add compatibility for MAC
 - Move `ci` and `release` Docker images from hub.docker.com to GitHub package repository
 - Add documentation in README.md
+- [BC Break] Fix `BootstrapProcess` class name, it was `BoostrapProcess` before
 
 ### [1.0.1](../../compare/1.0.0...1.0.1) - 2024-12-02
 

changelog.md

@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+    os: ubuntu-24.04
+    tools:
+        python: "3.13"
+    jobs:
+        pre_install:
+            - pip install mkdocs-material
+
+mkdocs:
+    configuration: docs/mkdocs.yml

docs/.readthedocs.yaml

@@ -0,0 +1,16 @@
+body {
+    cursor: default;
+}
+
+h1 {
+    margin-bottom: 0.5em !important;
+    color: #4051B5 !important;
+}
+
+div.md-main__inner {
+    margin-top: 0;
+}
+
+:root {
+    --md-typeset-a-color: #30a2a9;
+}

docs/assets/css/theme.css

@@ -0,0 +1,6 @@
+document.addEventListener("DOMContentLoaded", function(event) {
+    document.querySelector(".md-search__input").addEventListener("focus", (e) => {
+        const event = new CustomEvent("readthedocs-search-show");
+        document.dispatchEvent(event);
+    });
+});

docs/assets/js/readthedocs-search.js

@@ -0,0 +1,21 @@
+# Work on the code
+
+You can add a volume from your project in `/composer/vendor/steevanb/php-parallel-processes` to work on the code:
+
+```bash hs_lines="5"
+docker run \
+    --rm \
+    -it \
+    -v $(pwd):/app \
+    -v $(pwd):/composer/vendor/steevanb/php-parallel-processes \
+    steevanb/php-parallel-processes:1.1.0-alpine \
+        php /app/parallel-processes.php 
+```
+
+# Work on the documentation
+
+We use readthedocs, mkdocs and Material for MkDocs.
+
+Documentation is written in Markdown in [docs/](https://github.com/steevanb/php-parallel-processes/tree/readthedocs/docs).
+
+See [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) for Markdown syntax and examples.

docs/contributing/tips-for-devs.md

@@ -0,0 +1,18 @@
+---
+title: "Compatibility"
+---
+
+# Compatibility
+
+`php-parallel-processes` is compatible with almost every development and production environment.
+
+# Installed as a Composer dependency
+
+- PHP ^8.2
+- [symfony/console](https://symfony.com/doc/current/components/console.html) ^7.0
+- [symfony/process](https://symfony.com/doc/current/components/process.html) ^7.0
+- Linux and macOS
+
+# Used with the Docker image
+
+- Docker — you should already have a compatible version

docs/getting-started/compatibility.md

@@ -0,0 +1,10 @@
+---
+title: "License"
+---
+
+# License
+
+`php-parallel-processes` is under [Apache 2.0 license](https://github.com/steevanb/php-parallel-processes/blob/master/LICENSE).
+
+The Apache 2.0 license allows you to freely use, modify, and distribute software, including for commercial purposes,
+as long as you keep the copyright and license notices and indicate any changes made.

docs/getting-started/license.md

@@ -0,0 +1,14 @@
+---
+title: "Summary"
+---
+
+# PHP parallel processes
+
+`php-parallel-processes` is an open source tool to execute processes in parallel, with these key features:
+
+- Install it as a [Composer dependency](installation/composer-dependency.md) or use the [Docker images](installation/docker-image.md) to avoid installing anything
+- Configure your processes in PHP
+- Verbosity to define if you want to execute processes without showing each process output, show execution time, show only error outputs or all outputs
+- Configure when your process should start: immediately, wait for another process (successful, failed or terminated), bootstrap or tear down
+- Configure each process: name, command, max execution time, output verbosity, etc.
+- Choose your theme, or create your own

docs/index.md

@@ -0,0 +1,17 @@
+---
+title: "Installation - Composer dependency"
+---
+
+# Composer dependency
+
+If you want to install `php-parallel-processses` in your project, with Composer:
+
+```bash
+composer require steevanb/php-parallel-processes:^1.0
+```
+
+# Available versions
+
+See [releases](https://github.com/steevanb/php-parallel-processes/releases).
+
+See [changelog](https://github.com/steevanb/php-parallel-processes/blob/master/changelog.md).