1
0
Fork 0
mirror of https://github.com/anrieff/libcpuid synced 2025-10-03 11:01:30 +00:00

Document the Python bindings using Sphinx

Additionally, setup the documentation for
deployment to Read The Docs.
This commit is contained in:
Pavol Žáčik 2024-07-23 18:04:47 +02:00 committed by The Tumultuous Unicorn Of Darkness
commit ec938b5d42
15 changed files with 226 additions and 1 deletions

View file

@ -171,6 +171,13 @@ When no options are present, the program behaves as if it was invoked with
cpuid_tool "--save=raw.txt --outfile=report.txt --report --verbose"
```
### Python bindings
The libcpuid library features Python bindings, which can be installed as a library
using `python -m pip install libcpuid`. Visit the
[documentation at Read the Docs](https://libcpuid.readthedocs.io/en/latest/index.html#)
to see how the library is used.
## Contributing
Refer to the [dedicated page](CONTRIBUTING.md).