From 805d613ec9475155ce60088730c842fcc947c492 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 8 Jul 2017 17:30:12 +0000 Subject: [PATCH] rearrange existing documentation to fit the new standard layout Part of doc-migration work. For more detail, see: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html https://etherpad.openstack.org/p/doc-migration-tracking Change-Id: I545f16d6fe1fd3c2ed76f71b0ff79f93f3a1996e --- .../{contributing.rst => contributor/index.rst} | 2 +- doc/source/index.rst | 17 +++++++++-------- .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 1 - doc/source/{usage.rst => user/index.rst} | 0 5 files changed, 10 insertions(+), 10 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (50%) rename doc/source/{installation.rst => install/index.rst} (100%) delete mode 100644 doc/source/readme.rst rename doc/source/{usage.rst => user/index.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 1728a61c..2aa07077 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 96d9fed4..ee10e633 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,21 +3,22 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to ovsdbapp's documentation! -======================================================== +.. the main title comes from README.rst -Contents: +.. include:: ../../README.rst + +Contents +-------- .. toctree:: :maxdepth: 2 - readme - installation - usage - contributing + install/index + user/index + contributor/index Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` 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/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.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