This repository contains the source files and documentation for the DPIC book, built using Sphinx and localized for Persian (RTL).
Make sure you have Python (>= 3.8) and Git installed on your system.
-
Clone the repository:
git clone [https://github.com/DataistOS/dpic.git](https://github.com/DataistOS/dpic.git) cd dpic -
Install dependencies (using the Iranian PyPI mirror to bypass restrictions):
pip install sphinx myst-parser sphinx-rtd-theme sphinx-multiversion -i [https://mirror-pypi.runflare.com/simple](https://mirror-pypi.runflare.com/simple)
Depending on your needs, you can use one of the following commands to compile the documentation into HTML:
- Draft Mode (Local Live Preview)
To compile your current untracked/local drafts without making a Git commit, use: Bash
sphinx-build -c . _source _build/html
Output location: _build/html/index.html
- Multi-Version Mode (Production Build) To build all Git branches and tags (e.g., main, master, heuristic) after committing your changes: Bash
rm -rf _build/multiversion && sphinx-multiversion -c . _source _build/multiversionOutput location: _build/multiversion/
π Project Structure
Plaintext
βββ _build/ # Compiled HTML outputs (Git ignored)
βββ _source/ # Main book content (.rst files)
βββ _static/ # Custom assets, CSS, and fonts
βββ _templates/ # Sphinx HTML custom templates
βββ conf.py # Sphinx configuration file
βββ README.md # This documentation guide
βοΈ Contribution Guide
- Create a new branch for your edits (e.g., git checkout -b feature/chapter-X).
- Write your content inside the _source/ directory using reStructuredText (RST).
- Keep Linux commands and syntax code blocks Left-to-Right (LTR).
- Verify the layout using the Draft Mode build command before sending a Merge Request.