Browse Source

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
tags/5.0.0.0b1
Zhenguo Niu 2 years ago
parent
commit
271cf5ca34
3 changed files with 23 additions and 1 deletions
  1. 4
    0
      doc/source/contributing.rst
  2. 18
    1
      doc/source/index.rst
  3. 1
    0
      doc/source/readme.rst

+ 4
- 0
doc/source/contributing.rst View File

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

+ 18
- 1
doc/source/index.rst View File

@@ -1 +1,18 @@
1
-.. include:: ../../README.rst
1
+
2
+Welcome to Mistral Dashboard's documentation!
3
+============================================
4
+
5
+Contents:
6
+
7
+.. toctree::
8
+   :maxdepth: 1
9
+
10
+   readme
11
+   contributing
12
+
13
+Indices and tables
14
+==================
15
+
16
+* :ref:`genindex`
17
+* :ref:`modindex`
18
+* :ref:`search`

+ 1
- 0
doc/source/readme.rst View File

@@ -0,0 +1 @@
1
+.. include:: ../../README.rst

Loading…
Cancel
Save