Generate Documentation

Powered by Sphinx

Set Path in .env File

PHP_PATH=G:/xampp2/php/php.exe
SPHINX_PATH=C:/Users/ASUS/AppData/Local/Programs/Python/Python37-32/Scripts/sphinx-build.exe

Pre-Requirements

  • Python [check: python –version]

  • Sphinx Doc.

Install Python

# In windows:

Download and Install: https://www.python.org/downloads/

Check if install or not: python –version

Now, Install Sphinx pip install -U sphinx

Check if sphinx-doc install or not sphinx-build –version

Insall RTD Theme pip install sphinx-rtd-theme

Problem python, pip, sphinx-build commands is not working!

Solution Right click on This PC icon on dashboard > Advanced system settings > Environment Variables > Path

python [adjust path as you installed] pythonScripts [adjust path as you installed]

How to generate?

At first create a git repository and commit then run the commands below.

Commands

Syntax: php cli app:doc --soruce=dir_path --dest=dir_path

php cli app:doc --source="phspark/utils/doc" --dest="phspark/doc/main"