Skip to content

Commit 0c8ac55

Browse files
committed
doc: move update instruction into template
The documentation added in 7fecc48 ("doc: add quickstart and installation") and 6a9758b ("doc: update installation doc") should have been added to the template. Signed-off-by: Daniel Wagner <[email protected]>
1 parent db4aa1f commit 0c8ac55

2 files changed

Lines changed: 39 additions & 12 deletions

File tree

doc/index.rst.in

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
Welcome to libnvme's documentation!
22
===================================
33

4+
This is the libnvme development C library. libnvme provides type definitions for
5+
NVMe specification structures, enumerations, and bit fields,
6+
helper functions to construct, dispatch, and decode commands and payloads,
7+
and utilities to connect, scan, and manage nvme devices on a Linux system.
8+
49
.. toctree::
510
:maxdepth: 2
611
:caption: Contents:
712

8-
.. include:: rst/types.rst
9-
.. include:: rst/ioctl.rst
10-
.. include:: rst/fabrics.rst
11-
.. include:: rst/linux.rst
12-
.. include:: rst/tree.rst
13-
.. include:: rst/filters.rst
14-
.. include:: rst/util.rst
15-
.. include:: rst/log.rst
16-
13+
installation.rst
14+
quickstart.rst
15+
api.rst
1716

1817
Indices and tables
1918
==================

doc/installation.rst.in

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,47 @@
11
Installation
22
============
33

4+
Debian / Ubuntu:
5+
--------------
6+
7+
.. code-block:: sh
8+
9+
$ apt-get install libnvme
10+
11+
Fedora / Red Hat:
12+
--------------
13+
14+
.. code-block:: sh
15+
16+
$ dnf install libnvme
17+
418
Python Version
519
--------------
620

7-
tbd
21+
The latest Python 3 version is always recommended, since it has all the latest bells and
22+
whistles. libnvme supports Python 3.6 and above.
823

924
Dependencies
1025
------------
1126

12-
tbd
27+
libnvme only uses packages from the standard library,
28+
so no additional dependencies will be installed when installing libnvme.
1329

14-
Install libnvme
30+
Install libnvme python
1531
-------------
1632

33+
Debian / Ubuntu:
34+
35+
.. code-block:: sh
36+
37+
$ apt-get install python3-libnvme
38+
39+
Fedora / Red Hat:
40+
41+
.. code-block:: sh
42+
43+
$ dnf install python3-libnvme
44+
1745
libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is
1846
always the latest stable release.
1947

0 commit comments

Comments
 (0)