Use better docs theme and clarify docs

This commit is contained in:
Luke Murphy
2019-11-03 16:15:14 +01:00
parent 9397108a64
commit 16d2ed16d9
8 changed files with 80 additions and 51 deletions

View File

@ -1,7 +1,7 @@
author = 'decentral1se'
copyright = '2019, decentral1se'
html_static_path = ['_static']
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
master_doc = 'index'
project = 'flat-tree'
templates_path = ['_templates']

View File

@ -1,12 +1,13 @@
.. include:: ../../README.rst
:end-before: _documentation
Table of Contents
*****************
.. toctree::
:maxdepth: 1
:hidden:
install
upgrade
example
modules-api
other-impls
contribute

View File

@ -0,0 +1,7 @@
*******
Upgrade
*******
.. code-block:: bash
$ pip install --upgrade flat-tree