Building documentation

To build documentation for the projects in this repository, you first need to install Sphynx, using the following commands:

pip3 install -r docs/requirements.txt

Once all dependencies have been installed, HTML documentation can be built by calling the following commands:

cd <path-to-repository>/docs
make html

Release checklist

Before releasing a new version of the project, the following steps should be performed:

1. Ensure content parity between all readmes and the documentation.

   • README.rst

   • LICENSE.md

   • simplepyble/README.rst

   • simplersble/README.md

2. Review/update the version number in the following files:

   • VERSION

   • Cargo.toml

   • docs/changelog.rst

   • setup.py (Add or remove the .devX suffix as needed.)

3. Commit the changes to the repository.

4. Tag the commit with the new version number.

5. Push the commit and the tag to the remote repository.

6. Create a new release on GitHub.

7. Run the CI job to build and upload the package to PyPI.

8. Run the CI job to build and upload the artifacts to GitHub.

9. Perform a manual release of the Rust crate to crates.io. - cargo publish (Ensure that the version number in Cargo.toml is correct.)

10. Advance the version number in the following files:

    • VERSION

    • Cargo.toml

    • docs/changelog.rst

    • setup.py (Add or remove the .devX suffix as needed.)