doc: add quickstart and installation

glimchb · glimchb · commit 7fecc4881a3c · 2022-04-13T11:48:53.000+03:00
Signed-off-by: Boris Glimcher &lt;Boris.Glimcher@emc.com&gt;
diff --git a/doc/api.rst b/doc/api.rst
@@ -0,0 +1,17 @@
+===
+API
+===
+
+.. module:: libnvme
+
+This part of the documentation lists the full API reference of all public classes and
+functions.
+
+.. include::   rst/types.rst
+.. include::   rst/ioctl.rst
+.. include::   rst/fabrics.rst
+.. include::   rst/linux.rst
+.. include::   rst/tree.rst
+.. include::   rst/filters.rst
+.. include::   rst/util.rst
+.. include::   rst/log.rst
diff --git a/doc/api.rst.in b/doc/api.rst.in
@@ -0,0 +1,17 @@
+===
+API
+===
+
+.. module:: libnvme
+
+This part of the documentation lists the full API reference of all public classes and
+functions.
+
+.. include::   rst/types.rst
+.. include::   rst/ioctl.rst
+.. include::   rst/fabrics.rst
+.. include::   rst/linux.rst
+.. include::   rst/tree.rst
+.. include::   rst/filters.rst
+.. include::   rst/util.rst
+.. include::   rst/log.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,19 +1,18 @@
 Welcome to libnvme's documentation!
 ===================================
 
+This is the libnvme development C library. libnvme provides type definitions for
+NVMe specification structures, enumerations, and bit fields,
+helper functions to construct, dispatch, and decode commands and payloads,
+and utilities to connect, scan, and manage nvme devices on a Linux system.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-.. include::   rst/types.rst
-.. include::   rst/ioctl.rst
-.. include::   rst/fabrics.rst
-.. include::   rst/linux.rst
-.. include::   rst/tree.rst
-.. include::   rst/filters.rst
-.. include::   rst/util.rst
-.. include::   rst/log.rst
-
+   installation.rst
+   quickstart.rst
+   api.rst
 
 Indices and tables
 ==================
diff --git a/doc/installation.rst b/doc/installation.rst
@@ -0,0 +1,24 @@
+Installation
+============
+
+Python Version
+--------------
+
+tbd
+
+Dependencies
+------------
+
+tbd
+
+Install libnvme
+-------------
+
+libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is
+always the latest stable release.
+
+.. _PyPi: https://pypi.org/project/libnvme/
+
+.. code-block:: sh
+
+    $ pip install libnvme
diff --git a/doc/installation.rst.in b/doc/installation.rst.in
@@ -0,0 +1,24 @@
+Installation
+============
+
+Python Version
+--------------
+
+tbd
+
+Dependencies
+------------
+
+tbd
+
+Install libnvme
+-------------
+
+libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is
+always the latest stable release.
+
+.. _PyPi: https://pypi.org/project/libnvme/
+
+.. code-block:: sh
+
+    $ pip install libnvme
diff --git a/doc/meson.build b/doc/meson.build
@@ -21,7 +21,10 @@ api_files = [
 
 sphinx_sources = [
     'conf.py',
+    'api.rst',
     'index.rst',
+    'quickstart.rst',
+    'installation.rst',
     'config-schema.json'
 ]
 
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
@@ -0,0 +1,5 @@
+==========
+Quickstart
+==========
+
+tbd
diff --git a/doc/quickstart.rst.in b/doc/quickstart.rst.in
@@ -0,0 +1,5 @@
+==========
+Quickstart
+==========
+
+tbd

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,10 @@ api_files = [`
`21`	`21`
`22`	`22`	`sphinx_sources = [`
`23`	`23`	`'conf.py',`
	`24`	`+ 'api.rst',`
`24`	`25`	`'index.rst',`
	`26`	`+ 'quickstart.rst',`
	`27`	`+ 'installation.rst',`
`25`	`28`	`'config-schema.json'`
`26`	`29`	`]`
`27`	`30`