Browse Source

rearrange content using the new standard layout

Also turn on warning-is-error for the sphinx build.

Change-Id: I4a839924212fde7e6ae31a87ea8a0c6cf45313e9
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
changes/53/478653/1
Doug Hellmann 4 years ago
parent
commit
637a6b4a6e
  1. 4
      doc/source/contributing.rst
  2. 5
      doc/source/contributor/index.rst
  3. 16
      doc/source/index.rst
  4. 0
      doc/source/install/index.rst
  5. 0
      doc/source/user/index.rst
  6. 1
      setup.cfg

4
doc/source/contributing.rst

@ -1,4 +0,0 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

5
doc/source/contributor/index.rst

@ -0,0 +1,5 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst

16
doc/source/index.rst

@ -3,21 +3,19 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to designatedashboard's documentation!
========================================================
Contents:
================================================
Welcome to designatedashboard's documentation!
================================================
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
install/index
user/index
contributor/index
Indices and tables
==================
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`search`

0
doc/source/installation.rst → doc/source/install/index.rst

0
doc/source/usage.rst → doc/source/user/index.rst

1
setup.cfg

@ -26,6 +26,7 @@ packages =
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html

Loading…
Cancel
Save