diff options
author | Doug Hellmann <doug@doughellmann.com> | 2017-07-07 14:26:34 -0400 |
---|---|---|
committer | Doug Hellmann <doug@doughellmann.com> | 2017-07-11 13:49:30 -0400 |
commit | 9014fdd8d4851be369ad4f0ced2cb8c26f7f345a (patch) | |
tree | aa97665a02dee280bf39a7fcf802ab234cc0c8a8 /doc | |
parent | 9d6ba40bd5ebb893c53eafa115bbf820030e2b2b (diff) | |
download | oslo-concurrency-9014fdd8d4851be369ad4f0ced2cb8c26f7f345a.tar.gz |
rearrange existing documentation to follow the new layout standard
Change-Id: I79d7b97c7e9395f75fa158d870485853418a4db7
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/configuration/index.rst (renamed from doc/source/opts.rst) | 0 | ||||
-rw-r--r-- | doc/source/contributor/contributing.rst (renamed from doc/source/contributing.rst) | 2 | ||||
-rw-r--r-- | doc/source/contributor/history.rst | 1 | ||||
-rw-r--r-- | doc/source/contributor/index.rst | 9 | ||||
-rw-r--r-- | doc/source/history.rst | 1 | ||||
-rw-r--r-- | doc/source/index.rst | 25 | ||||
-rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/fixture.lockutils.rst (renamed from doc/source/api/fixture.lockutils.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/index.rst (renamed from doc/source/api/index.rst) | 4 | ||||
-rw-r--r-- | doc/source/reference/lockutils.rst (renamed from doc/source/api/lockutils.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/opts.rst (renamed from doc/source/api/opts.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/processutils.rst (renamed from doc/source/api/processutils.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/watchdog.rst (renamed from doc/source/api/watchdog.rst) | 0 | ||||
-rw-r--r-- | doc/source/user/index.rst (renamed from doc/source/usage.rst) | 2 |
14 files changed, 21 insertions, 23 deletions
diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst index 27ee4fb..27ee4fb 100644 --- a/doc/source/opts.rst +++ b/doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/history.rst b/doc/source/contributor/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/contributor/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..ae57822 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +===================== + Contributor's Guide +===================== + +.. toctree:: + :maxdepth: 2 + + contributing + history 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 4ff4a70..f2297d1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,26 +9,11 @@ external processes. .. toctree:: :maxdepth: 1 - installation - usage - opts - contributing - -API Documentation -================= - -.. toctree:: - :maxdepth: 1 - - api/index - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history + install/index + user/index + configuration/index + contributor/index + reference/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst index 0f63912..0f63912 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/api/fixture.lockutils.rst b/doc/source/reference/fixture.lockutils.rst index 8f82f40..8f82f40 100644 --- a/doc/source/api/fixture.lockutils.rst +++ b/doc/source/reference/fixture.lockutils.rst diff --git a/doc/source/api/index.rst b/doc/source/reference/index.rst index 2ee39d8..60abf32 100644 --- a/doc/source/api/index.rst +++ b/doc/source/reference/index.rst @@ -1,3 +1,7 @@ +=============== + API Reference +=============== + .. toctree:: :maxdepth: 1 diff --git a/doc/source/api/lockutils.rst b/doc/source/reference/lockutils.rst index 76a37fa..76a37fa 100644 --- a/doc/source/api/lockutils.rst +++ b/doc/source/reference/lockutils.rst diff --git a/doc/source/api/opts.rst b/doc/source/reference/opts.rst index 8972b27..8972b27 100644 --- a/doc/source/api/opts.rst +++ b/doc/source/reference/opts.rst diff --git a/doc/source/api/processutils.rst b/doc/source/reference/processutils.rst index 787095c..787095c 100644 --- a/doc/source/api/processutils.rst +++ b/doc/source/reference/processutils.rst diff --git a/doc/source/api/watchdog.rst b/doc/source/reference/watchdog.rst index feccaeb..feccaeb 100644 --- a/doc/source/api/watchdog.rst +++ b/doc/source/reference/watchdog.rst diff --git a/doc/source/usage.rst b/doc/source/user/index.rst index dd8ba98..1867faf 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/index.rst @@ -10,7 +10,7 @@ example:: .. seealso:: - * :doc:`API Documentation <api/index>` + * :doc:`API Documentation <../reference/index>` Locking a function (local to a process) ======================================= |