Improve index, installation and usage pages of documentation (#15)

koenvervloesem · Dec 28, 2022 · ca759b4 · ca759b4
1 parent 5da925f
commit ca759b4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -35,6 +35,8 @@ The following sources are used:
 * `Bluetooth Assigned Numbers <https://www.bluetooth.com/specifications/assigned-numbers/>`_ for SDO Service UUIDs and Member Service UUIDs
 * The `IEEE database of OUIs <https://standards-oui.ieee.org/oui/oui.txt>`_ for prefixes of Bluetooth addresses
 
+.. inclusion-marker-after-intro
+
 Installation
 ============
 
@@ -91,6 +93,10 @@ Get the description of an OUI:
 	>>> oui["58:2D:34"]
 	'Qingping Electronics (Suzhou) Co., Ltd'
 
+See the `module reference <https://bluetooth-numbers.readthedocs.io/en/latest/api/modules.html>`_ for complete documentation.
+
+.. inclusion-marker-before-license
+
 License
 =======
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,16 +1,13 @@
-=================
-bluetooth-numbers
-=================
-
-This is the documentation of **bluetooth-numbers**.
+.. include:: ../README.rst
+   :end-before: inclusion-marker-after-intro
 
 Contents
 ========
 
 .. toctree::
    :maxdepth: 2
 
-   Overview <readme>
+   Installation and usage <usage>
    Contributions & Help <contributing>
    License <license>
    Authors <authors>

diff --git a/docs/readme.rst b/docs/readme.rst
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -0,0 +1,7 @@
+======================
+Installation and usage
+======================
+
+.. include:: ../README.rst
+   :start-after: inclusion-marker-after-intro
+   :end-before: inclusion-marker-before-license