mirror of
https://github.com/anrieff/libcpuid
synced 2025-07-02 14:04:15 +00:00
Document the Python bindings using Sphinx
Additionally, setup the documentation for deployment to Read The Docs.
This commit is contained in:
parent
40e2d5fcb6
commit
ec938b5d42
15 changed files with 226 additions and 1 deletions
6
python/docs/api/clock.rst
Normal file
6
python/docs/api/clock.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
Clock and frequency computation
|
||||
===============================
|
||||
|
||||
.. automodule:: libcpuid.clock
|
||||
:members:
|
||||
:undoc-members:
|
6
python/docs/api/enums.rst
Normal file
6
python/docs/api/enums.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
Enumeration classes
|
||||
===================
|
||||
|
||||
.. automodule:: libcpuid.enums
|
||||
:members:
|
||||
:undoc-members:
|
5
python/docs/api/errors.rst
Normal file
5
python/docs/api/errors.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
Library exceptions
|
||||
==================
|
||||
|
||||
.. automodule:: libcpuid.errors
|
||||
:members:
|
22
python/docs/api/info.rst
Normal file
22
python/docs/api/info.rst
Normal file
|
@ -0,0 +1,22 @@
|
|||
Basic CPU information
|
||||
=====================
|
||||
|
||||
.. autoclass:: libcpuid.info.CPUInfo
|
||||
:members:
|
||||
:exclude-members: from_c
|
||||
|
||||
.. autoclass:: libcpuid.info.X86Info
|
||||
:members:
|
||||
|
||||
.. autoclass:: libcpuid.info.ARMInfo
|
||||
:members:
|
||||
|
||||
.. autoclass:: libcpuid.sgx.SGX
|
||||
:members:
|
||||
|
||||
.. autoclass:: libcpuid.sgx.EPC
|
||||
:members:
|
||||
|
||||
.. autoclass:: libcpuid.info.SystemInfo
|
||||
:members:
|
||||
:exclude-members: from_c
|
5
python/docs/api/libcpuid.rst
Normal file
5
python/docs/api/libcpuid.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
Top-level library functionality
|
||||
===============================
|
||||
|
||||
.. automodule:: libcpuid
|
||||
:members:
|
6
python/docs/api/msr.rst
Normal file
6
python/docs/api/msr.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
Model-specific registers
|
||||
========================
|
||||
|
||||
.. automodule:: libcpuid.msr
|
||||
:members:
|
||||
:undoc-members:
|
10
python/docs/api/raw.rst
Normal file
10
python/docs/api/raw.rst
Normal file
|
@ -0,0 +1,10 @@
|
|||
Raw CPU data
|
||||
============
|
||||
|
||||
.. autoclass:: libcpuid.raw.CPURawData
|
||||
:members:
|
||||
:exclude-members: c_cpu_raw_data
|
||||
|
||||
.. autoclass:: libcpuid.raw.CPURawDataArray
|
||||
:members:
|
||||
:exclude-members: c_cpu_raw_data_array
|
Loading…
Add table
Add a link
Reference in a new issue