update docs

This commit is contained in:
Wes Barnett 2021-03-28 09:00:01 -04:00
parent 3da59ac9d3
commit ea778aa380
No known key found for this signature in database
GPG key ID: 1070BCC98C18BD66
2 changed files with 23 additions and 1 deletions

View file

@ -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
<https://wesbarnett.github.io/snap-pac/>`_ 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:

View file

@ -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