From ea778aa38002858e624adca4414018adc19cfe5c Mon Sep 17 00:00:00 2001 From: Wes Barnett Date: Sun, 28 Mar 2021 09:00:01 -0400 Subject: [PATCH] update docs --- docs/source/installation.rst | 8 ++++++++ man8/snap-pac.8 | 16 +++++++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 3bbd0a6..159056d 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -47,6 +47,14 @@ For testing, ``pytest`` is required. To run the tests do: Documentation ------------- +Typically, you will not need to build the documentation on your own and can simply +access it by visiting the `online documentation +`_ or by accessing the manpage: + +.. code-block:: bash + + man 8 snap-pac + To build the documentation, ``sphinx`` is required. To build the documentation you can do: diff --git a/man8/snap-pac.8 b/man8/snap-pac.8 index b5f9a01..ca03a43 100644 --- a/man8/snap-pac.8 +++ b/man8/snap-pac.8 @@ -156,6 +156,19 @@ make test .UNINDENT .SS Documentation .sp +Typically, you will not need to build the documentation on your own and can simply +access it by visiting the \fI\%online documentation\fP or by accessing the manpage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +man 8 snap\-pac +.ft P +.fi +.UNINDENT +.UNINDENT +.sp To build the documentation, \fBsphinx\fP is required. To build the documentation you can do: .INDENT 0.0 @@ -163,13 +176,14 @@ do: .sp .nf .ft C -sphinx\-build docs/source docs/build +make docs .ft P .fi .UNINDENT .UNINDENT .sp The resulting html documentation will then be located at \fBdocs/build/index.html\fP\&. +Additionally, this generates the manpage which will be located under \fBman8\fP\&. .SH CONFIGURATION .sp Configuration is done via Python ini configuration files. The defaults