Update pynssp doc

CDCgov · Apr 28, 2023 · 2c9a424 · 2c9a424
1 parent 69f6444
commit 2c9a424
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 14 deletions.
diff --git a/DISCLAIMER.md b/DISCLAIMER.md
@@ -1,4 +1,4 @@
-# DISCLAIMER
+# Disclaimer
 Use of this service is limited only to **non-sensitive and publicly available
 data**. Users must not use, share, or store any kind of sensitive data like
 health status, provision or payment of healthcare, Personally Identifiable

diff --git a/HISTORY.md b/HISTORY.md
@@ -1,5 +1,5 @@
-# History
+# ChangeLogs
 
 ## 0.1.0 (2023-??-??)
 
-* First release on PyPI.
+* First release on PyPI (upcoming - not yet released on PyPI).
diff --git a/docs/codeofconduct.rst b/docs/codeofconduct.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../CODE_OF_CONDUCT.md
diff --git a/docs/disclaimer.rst b/docs/disclaimer.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../DISCLAIMER.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,16 +3,28 @@ Welcome to pynssp's documentation!
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Overview:
 
    readme
    installation
    usage
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Modules:
+
    modules
-   contributing
-   authors
    history
 
+.. toctree::
+   :maxdepth: 2
+   :caption: About:
+
+   authors
+   contributing
+   disclaimer
+   codeofconduct
+
 Indices and tables
 ==================
 * :ref:`genindex`

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -5,19 +5,19 @@ Installation
 ============
 
 
-Stable release
---------------
+.. Stable release
+.. --------------
 
-To install pynssp, run this command in your terminal:
+.. To install pynssp, run this command in your terminal:
 
-.. code-block:: console
+.. .. code-block:: console
 
-    $ pip install pynssp
+..     $ pip install pynssp
 
-This is the preferred method to install pynssp, as it will always install the most recent stable release.
+.. This is the preferred method to install pynssp, as it will always install the most recent stable release.
 
-If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-you through the process.
+.. If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+.. you through the process.
 
 .. _pip: https://pip.pypa.io
 .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
@@ -32,6 +32,8 @@ You may install the development version with `pip`_ by running this command in y
 
     $ pip install git+https://github.com/cdcgov/pynssp.git
 
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
 
 From sources
 ------------