diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-07-05 01:54:52 +0900 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-07-05 01:57:01 +0900 |
| commit | cdb50bed6e76930f1b0f4c6272166880ef5304ed (patch) | |
| tree | f4cdcb295010bff9f62fbfee9cf27ef4cf177feb | |
| parent | 3ce185402ede727be4759e6f64813dace6167b89 (diff) | |
| download | oslo-context-cdb50bed6e76930f1b0f4c6272166880ef5304ed.tar.gz | |
rearrange the documentation to fit into the new standard layout
Change-Id: If9bd83a0ac47084e025899cee681feef06265406
| -rw-r--r-- | doc/source/contributor/index.rst (renamed from doc/source/contributing.rst) | 2 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/context.rst (renamed from doc/source/api/context.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/fixture.rst (renamed from doc/source/api/fixture.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst (renamed from doc/source/api/index.rst) | 6 | ||||
| -rw-r--r-- | doc/source/user/examples.rst (renamed from doc/source/examples.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/examples/usage.py (renamed from doc/source/examples/usage.py) | 0 | ||||
| -rw-r--r-- | doc/source/user/examples/usage_simple.py (renamed from doc/source/examples/usage_simple.py) | 0 | ||||
| -rw-r--r-- | doc/source/user/examples/usage_user_identity.py (renamed from doc/source/examples/usage_user_identity.py) | 0 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 15 | ||||
| -rw-r--r-- | doc/source/user/usage.rst (renamed from doc/source/usage.rst) | 0 |
14 files changed, 24 insertions, 11 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 411f6f3..ec2f4f2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,11 +5,9 @@ Contents: .. toctree:: :maxdepth: 2 - installation - usage - examples - contributing - history + install/index + user/index + contributor/index Code Documentation ================== @@ -17,7 +15,7 @@ Code Documentation .. toctree:: :maxdepth: 1 - api/index + reference/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst index 0ee7ae1..0ee7ae1 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/api/context.rst b/doc/source/reference/context.rst index d9ddf35..d9ddf35 100644 --- a/doc/source/api/context.rst +++ b/doc/source/reference/context.rst diff --git a/doc/source/api/fixture.rst b/doc/source/reference/fixture.rst index 58ef47f..58ef47f 100644 --- a/doc/source/api/fixture.rst +++ b/doc/source/reference/fixture.rst diff --git a/doc/source/api/index.rst b/doc/source/reference/index.rst index a123a00..878a0dc 100644 --- a/doc/source/api/index.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -================== - oslo.context API -================== +============= +API reference +============= .. toctree:: :maxdepth: 1 diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst index c5d2f70..c5d2f70 100644 --- a/doc/source/examples.rst +++ b/doc/source/user/examples.rst diff --git a/doc/source/examples/usage.py b/doc/source/user/examples/usage.py index aa5318f..aa5318f 100644 --- a/doc/source/examples/usage.py +++ b/doc/source/user/examples/usage.py diff --git a/doc/source/examples/usage_simple.py b/doc/source/user/examples/usage_simple.py index 3c247f8..3c247f8 100644 --- a/doc/source/examples/usage_simple.py +++ b/doc/source/user/examples/usage_simple.py diff --git a/doc/source/examples/usage_user_identity.py b/doc/source/user/examples/usage_user_identity.py index c0a2c4f..c0a2c4f 100644 --- a/doc/source/examples/usage_user_identity.py +++ b/doc/source/user/examples/usage_user_identity.py diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..366d03c --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,15 @@ +================== +Using oslo.context +================== + +.. toctree:: + :maxdepth: 2 + + usage + examples + +.. history contains a lot of sections, toctree with maxdepth 1 is used. +.. toctree:: + :maxdepth: 1 + + history diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst index ef01467..ef01467 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst |