From 637a6b4a6ec69f8d002b2c567f053c8765b5241d Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 28 Jun 2017 17:44:26 -0400 Subject: [PATCH] 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 --- doc/source/contributing.rst | 4 ---- doc/source/contributor/index.rst | 5 +++++ doc/source/index.rst | 16 +++++++--------- .../{installation.rst => install/index.rst} | 0 doc/source/{usage.rst => user/index.rst} | 0 setup.cfg | 1 + 6 files changed, 13 insertions(+), 13 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{usage.rst => user/index.rst} (100%) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ed77c12..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..3d4ceb4 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 9dae1f9..2bced7e 100644 --- a/doc/source/index.rst +++ b/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` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/usage.rst b/doc/source/user/index.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/index.rst diff --git a/setup.cfg b/setup.cfg index a8da6f1..0a48004 100644 --- a/setup.cfg +++ b/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