Browse Source

rearrange existing documentation based on the new standard layout

Change-Id: Iec6fee3e963355c166f8d4917e934f1d5186f834
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Doug Hellmann 1 year ago
parent
commit
a40362806a
5 changed files with 7 additions and 12 deletions
  1. 3
    8
      README.rst
  2. 1
    1
      doc/source/contributor/index.rst
  3. 2
    2
      doc/source/index.rst
  4. 0
    1
      doc/source/readme.rst
  5. 1
    0
      doc/source/user/index.rst

+ 3
- 8
README.rst View File

@@ -1,15 +1,10 @@
1
-========================
2
-Team and repository tags
3
-========================
1
+===========================================
2
+ Mox3 - Mock object framework for Python 3
3
+===========================================
4 4
 
5 5
 .. image:: http://governance.openstack.org/badges/mox3.svg
6 6
     :target: http://governance.openstack.org/reference/tags/index.html
7 7
 
8
-.. Change things from this point on
9
-
10
-Mox3 - Mock object framework for Python 3
11
-=========================================
12
-
13 8
 Mox3 is an unofficial port of the Google mox framework
14 9
 (http://code.google.com/p/pymox/) to Python 3. It was meant to be as compatible
15 10
 with mox as possible, but small enhancements have been made. The library was

doc/source/contributing.rst → doc/source/contributor/index.rst View File

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

+ 2
- 2
doc/source/index.rst View File

@@ -9,8 +9,8 @@ Contents
9 9
 .. toctree::
10 10
    :maxdepth: 2
11 11
 
12
-   readme
13
-   contributing
12
+   user/index
13
+   contributor/index
14 14
 
15 15
 Indices and tables
16 16
 ==================

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

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

+ 1
- 0
doc/source/user/index.rst View File

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

Loading…
Cancel
Save