1
0
Fork 0
mirror of https://github.com/anrieff/libcpuid synced 2025-07-12 14:14:12 +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
parent 40e2d5fcb6
commit ec938b5d42
15 changed files with 226 additions and 1 deletions

51
python/docs/index.rst Normal file
View file

@ -0,0 +1,51 @@
Welcome to libcpuid's documentation!
====================================
**libcpuid** provides a Python interface
to the libcpuid C library.
.. code-block:: python
import sys
import libcpuid
from libcpuid.errors import LibcpuidError
from libcpuid.info import CPUInfo
from libcpuid.enums import CPUFeature, CPUVendor
# print the version of the libcpuid library
print(libcpuid.version())
# print the number of CPU cores
print(libcpuid.get_total_cpus())
# check if the cpuid instruction is available
if not libcpuid.cpuid_present():
print("CPUInfo instruction is not available")
sys.exit(1)
try:
# identify the current CPU and print some
# information about it
cpu_info = CPUInfo.from_current_cpu()
print(cpu_info.vendor)
print(cpu_info.architecture)
print(CPUFeature.FPU in cpu_info.features)
# print the list of all Intel CPU code names
print(libcpuid.get_cpu_list(CPUVendor.INTEL))
except LibcpuidError as err:
print(err.message)
sys.exit(1)
.. toctree::
:maxdepth: 2
Home <self>
api/libcpuid
api/info
api/msr
api/enums
api/raw
api/clock
api/errors