Documentation updated for the new utility functions and partitions

petersulyok · Oct 23, 2022 · bed252a · bed252a
1 parent be813f2
commit bed252a
Show file tree

Hide file tree

Showing 12 changed files with 310 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -11,26 +11,28 @@ Disk information Python library can assist in collecting disk information on Lin
 - collect information about a specific disk
 - explore existing disks in the system
 - translate between traditional and persistent disk names
-- read disk temperature
-- read SMART data of the disk
+- read current disk temperature
+- read SMART data of a disk
+- read partition list of a disk 
 
 Installation
 ------------
-Standard installation from [pypi.org](https://pypi.irg):
+Standard installation from [pypi.org](https://pypi.org):
 
     pip install diskinfo
 
 The package requires Python version >= `3.7`. 
 
 Demo
 ----
-The library contains a simple demo, it can be executed in the following way:
+The library contains multiple demo screens ([`rich`](https://pypi.org/project/rich) needs to be installed):
 
+    pip install rich
     python -m diskinfo.demo
 
-<img src="https://github.com/petersulyok/diskinfo/raw/main/docs/diskinfo_rich_demo.png" align="left">
+![Demo screen](https://github.com/petersulyok/diskinfo/raw/main/docs/diskinfo_rich_demo.png)
 
-Please note that [rich](https://pypi.org/project/rich/) Python library needs to be installed for this colorful demo.
+See more demo screens in the [documentation](https://diskinfo.readthedocs.io/en/latest/intro.html#demo).
 
 API documentation
 -----------------

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,6 +1,7 @@
 API reference
 =============
-In this section you will find the detailed API reference about the implemented classes of ``diskinfo`` library.
+In this section you will find the detailed API reference about the implemented classes and functions
+of ``diskinfo`` library.
 
 .. toctree::
 
@@ -9,4 +10,6 @@ In this section you will find the detailed API reference about the implemented c
     disksmart.rst
     smartattr.rst
     nvmeattr.rst
+    partition.rst
     diskinfo.rst
+    utils.rst
diff --git a/docs/source/disk.rst b/docs/source/disk.rst
@@ -1,6 +1,6 @@
 .. py:currentmodule:: diskinfo
 
-``Disk`` class
+`Disk` class
 --------------
 .. autoclass:: Disk
     :members:
diff --git a/docs/source/diskinfo.rst b/docs/source/diskinfo.rst
@@ -1,6 +1,6 @@
 .. py:currentmodule:: diskinfo
 
-``DiskInfo`` class
+`DiskInfo` class
 ------------------
 .. autoclass:: DiskInfo
     :members:
diff --git a/docs/source/disksmart.rst b/docs/source/disksmart.rst
@@ -1,6 +1,6 @@
 .. py:currentmodule:: diskinfo
 
-``DiskSmartData`` class
+`DiskSmartData` class
 -----------------------
 .. autoclass:: DiskSmartData
     :members:
diff --git a/docs/source/disktype.rst b/docs/source/disktype.rst
@@ -1,6 +1,6 @@
 .. py:currentmodule:: diskinfo
 
-``DiskType`` class
+`DiskType` class
 ------------------
 .. autoclass:: DiskType
     :members: