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,28 @@
+body {
+    cursor: default;
+}
+
+h1 {
+    margin-bottom: 0.5em !important;
+    color: #4051B5 !important;
+    font-weight: 500 !important;
+}
+
+h2 {
+    margin-top: 0.5em !important;
+    margin-bottom: 0.5em !important;
+    color: #4051B5 !important;
+    font-size: 1.3em;
+}
+
+div.md-main__inner {
+    margin-top: 0;
+}
+
+:root {
+    --md-typeset-a-color: #30a2a9;
+}
+
+.icon-green {
+    color: #069006;
+}

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,29 @@
+---
+hide:
+  - toc
+---
+
+# 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 hl_lines="6"
+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](https://about.readthedocs.com/), 
+[mkdocs](https://docs.readthedocs.com/platform/stable/intro/mkdocs.html) 
+and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/).
+
+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 syntaxes and examples.

docs/contributing/tips-for-devs.md

@@ -0,0 +1,32 @@
+---
+hide:
+  - toc
+---
+
+# Compatibility
+
+`parallel-processes` is compatible with almost every development and production environment.
+
+# Installed as a Composer dependency
+
+<div class="grid cards" markdown>
+
+- :material-language-php: __PHP__ ^8.2
+- :material-penguin: __OS__ Linux and macOS
+- :material-symfony: __[symfony/console](https://symfony.com/doc/current/components/console.html)__ ^7.0
+- :material-symfony: __[symfony/process](https://symfony.com/doc/current/components/process.html)__ ^7.0
+
+</div>
+
+See [Installation with Composer](../installation/composer-dependency.md).
+
+# Used with the Docker image
+
+<div class="grid cards" markdown>
+
+- :material-docker: __Docker__ You should already have a compatible version
+- :material-penguin: __OS__ Linux, Windows and macOS
+
+</div>
+
+See [use it with Docker](../installation/docker-image.md).

docs/getting-started/compatibility.md

@@ -0,0 +1,11 @@
+---
+hide:
+  - toc
+---
+
+# License
+
+`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,64 @@
+---
+hide:
+  - toc
+---
+
+# Parallel processes
+
+`parallel-processes` is an open source tool to execute processes in parallel, with these key features:
+
+<div class="grid cards" markdown>
+
+-   :material-docker:{ .lg .middle } __Install it or use Docker images__
+
+    ---
+
+    Install it as a Composer dependency or use the Docker images to avoid installing anything.
+
+    [:octicons-arrow-right-24: Installation](installation/composer-dependency.md)
+
+-   :material-file-tree:{ .lg .middle } __Process start rules__
+
+    ---
+
+    Configure when your process should start: immediately, wait for another process, bootstrap or tear down.
+
+    [:octicons-arrow-right-24: Bootstrap or tear down](usage/bootstrap-tear-down.md)
+
+-   :material-cog-outline:{ .lg .middle } __Process configuration__
+
+    ---
+
+    Configure each process: name, command, max execution time, output verbosity, etc.
+
+    [:octicons-arrow-right-24: Configure process](usage/process-configuration.md)
+
+-   :material-cog-outline:{ .lg .middle } __Processes execution configuration__
+
+    ---
+
+    Configure your processes in PHP.
+
+    [:octicons-arrow-right-24: Minimal configuration](usage/minimal-configuration.md)
+
+-   :material-message-bulleted:{ .lg .middle } __Verbosity__
+
+    ---
+
+    Use verbosity to define if you want to show processes output, execution time, only error outputs or all outputs.
+
+    [:octicons-arrow-right-24: Output verbosity](usage/output-verbosity.md)
+
+-  :material-compare:{ .lg .middle } __Theme__
+
+    ---
+
+    Choose your theme between Default and Summary, or create your own.
+
+    [:octicons-arrow-right-24: Theme configuration](theme/configuration.md)
+
+</div>
+
+# License
+
+`parallel-processes` is under [Apache 2.0 license](getting-started/license.md).

docs/index.md

@@ -0,0 +1,18 @@
+---
+hide:
+  - toc
+---
+
+# Composer dependency
+
+If you want to install `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).