From 271cf5ca348c7947a85041bb53d4892c8b055383 Mon Sep 17 00:00:00 2001 From: Zhenguo Niu Date: Mon, 13 Feb 2017 14:36:19 +0800 Subject: [PATCH] Reorganize docs Currently our docs is only the README, this reorganized it and will add more docs later then add a job to publish it to docs.openstack.org Change-Id: Ic2bd2babaae863a89dfc78ad793daf2d552771f3 --- doc/source/contributing.rst | 4 ++++ doc/source/index.rst | 19 ++++++++++++++++++- doc/source/readme.rst | 1 + 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 doc/source/contributing.rst create mode 100644 doc/source/readme.rst diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..1728a61 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,4 @@ +============ +Contributing +============ +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 38ba804..33032dd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1 +1,18 @@ -.. include:: ../../README.rst \ No newline at end of file + +Welcome to Mistral Dashboard's documentation! +============================================ + +Contents: + +.. toctree:: + :maxdepth: 1 + + readme + contributing + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..38ba804 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst \ No newline at end of file