commit 678de3d01d4662eb3592e5b35fc6b771462047a6
parent 2508917f8694ea88b4c733fca2fc6ab886f2803b
Author: Daniel Moch <daniel@danielmoch.com>
Date: Mon, 3 Sep 2018 14:30:06 -0400
Minor reformatting for docs
Diffstat:
3 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/Makefile b/Makefile
@@ -83,6 +83,7 @@ dist: ## builds source and wheel package
docs: ## builds the sphinx documentation and opens in the browser
make -C docs html
+ make -C docs latexpdf
$(BROWSER) docs/build/html/index.html
install: ## install the package to the active Python's site-packages
diff --git a/README.rst b/README.rst
@@ -11,7 +11,7 @@ automatically sync'ed when nncli is brought online.
More detailed documentation can be found in the docs.
Requirements
-~~~~~~~~~~~~
+------------
- `Python 3`_
@@ -22,7 +22,7 @@ Requirements
- A love for the command line!
Installation
-~~~~~~~~~~~~
+------------
- Via pip (latest release):
@@ -44,7 +44,7 @@ Installation
- Stand up development environment: ``pipenv install --dev``
Features
-~~~~~~~~
+--------
- Console GUI
@@ -103,7 +103,7 @@ Features
- view and edit note category
Acknowledgements
-~~~~~~~~~~~~~~~~
+----------------
nncli is a fork of sncli_ by Eric Davis. This application further pulls in
and uses modified versions of the simplenote.py_ module by Daniel Schauenberg and
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,16 +25,18 @@ NextCloud Notes Command Line Interface
.. include:: ../../README.rst
+Contents
+--------
+
.. toctree::
:maxdepth: 2
- :caption: Contents:
configuration
usage
Indices and tables
-==================
+------------------
* :ref:`genindex`
* :ref:`search`
