Install the Python package
Run the following command to install the package:
pip install pydocusaurus
Extra features
Specify the optional dependencies to enable more features:
pip install pydocusaurus[option1,option2...]
| Option | |
|---|---|
test | Install the dependencies related to pytest. These dependencies are not used by the package but used by the unittests. |
dev | Install the developer's dependencies. These dependencies may be used for building the package. This tier already includes backends. |
Install the GitHub version
The GitHub version may be newer than the PyPI version during the development. If users want to install the GitHub version, please ensure that Git has been installed.
After that, run the following command to install the developer's version.
git clone https://github.com/cainmagi/pydocusaurus
cd pydocusaurus
python -m pip install .[dev]
If you would like, you can add -e option after pip install to make the installed
package editable. Any modification in the cloned project folder will take effects
when pydocusaurus is imported anywhere.
Run the tests
To verify whether the package is compatible with your device, please ensure that Git is available.
After that, clone the project and run the tests:
git clone -d 1 --single-branch https://github.com/cainmagi/pydocusaurus
cd pydocusaurus
python -m pip install -e .
python -m pytest
The package is only compatible with python>=3.14. If you find the package fails to
pass the tests, please