Run the MkDocs development server to view your documentation locally:
pip3 install requirements.txt
mkdocs serve
Merge "main" branch into "docs" branch to update documentation to main
This project is not currently licensed for public or commercial use. Please contact me if you are interested in obtaining a license. This software is proprietary and not open source. No rights are granted to use, copy, modify, or distribute this code without explicit written permission from the author.
Remove all the build files:
./clean.sh
Installing the pip package run:
pip3 install -e .
To manually build the package, follow these steps:
-
Ensure you have all the necessary dependencies installed:
pip3 install -r requirements.txt
-
Clean any previous builds:
./clean.sh
-
Build the package:
python3 setup.py sdist bdist_wheel
-
Verify the package:
twine check dist/*
-
Optionally, upload the package to PyPI:
twine upload dist/*