From 1e8a55ea10f2c617a093f028760cd7bb6e78a105 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 21 Jul 2017 08:51:43 +0200 Subject: [PATCH] Reorder content to follow new structure Follow the new common docs structure and rearrage content for it. Change-Id: I7c52236863a8b27656fcbf5870e3ff8dfa726955 --- .../{contributing.rst => contributor/index.rst} | 2 +- doc/source/index.rst | 14 +++++--------- doc/source/{installation.rst => install/index.rst} | 0 doc/source/user/index.rst | 13 +++++++++++++ doc/source/{ => user}/usage.rst | 0 5 files changed, 19 insertions(+), 10 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (50%) rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/usage.rst (100%) diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 1728a61..2aa0707 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -1,4 +1,4 @@ ============ Contributing ============ -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index ac780dc..9329c45 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,10 +1,6 @@ -.. bashate documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - +=================================== Welcome to bashate's documentation! -======================================================== +=================================== Contents: @@ -12,9 +8,9 @@ Contents: :maxdepth: 2 readme - installation - usage - contributing + install/index.rst + user/index.rst + contributor/index.rst Indices and tables ================== 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/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..c565d85 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,13 @@ +============= +Using bashate +============= + + +Contents: + +.. toctree:: + :maxdepth: 2 + + usage.rst + ../man/bashate.rst + diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst