diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-28 12:42:18 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2017-06-29 14:30:08 -0400 |
| commit | 01dead7bdd9a541cd4f575355a5226415a5afa08 (patch) | |
| tree | 838bd35e14399727102510bf8da7801b4206053e /doc | |
| parent | 1cf2f426ce275d5480dbb138c8149b1810f23c5a (diff) | |
| download | oslo-i18n-01dead7bdd9a541cd4f575355a5226415a5afa08.tar.gz | |
rearrange the documentation to fit into the new standard layout
Change-Id: Ibe6548b444a8f030ea7ba034b7d63622e32d3917
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/contributor/contributing.rst (renamed from doc/source/contributing.rst) | 2 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/contributor/policy.rst (renamed from doc/source/policy.rst) | 0 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 22 | ||||
| -rw-r--r-- | doc/source/reference/index.rst (renamed from doc/source/api.rst) | 8 | ||||
| -rw-r--r-- | doc/source/user/guidelines.rst (renamed from doc/source/guidelines.rst) | 4 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 11 | ||||
| -rw-r--r-- | doc/source/user/usage.rst (renamed from doc/source/usage.rst) | 2 |
10 files changed, 35 insertions, 25 deletions
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/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..cbb8376 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +=========================== + Contributing to oslo.i18n +=========================== + +.. toctree:: + :maxdepth: 2 + + contributing + policy diff --git a/doc/source/policy.rst b/doc/source/contributor/policy.rst index 7ff67af..7ff67af 100644 --- a/doc/source/policy.rst +++ b/doc/source/contributor/policy.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 fde034a..e52d8a1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,28 +6,14 @@ The oslo.i18n library contain utilities for working with internationalization (i18n) features, especially translation for text strings in an application or library. -Contents -======== - .. toctree:: :maxdepth: 2 - usage - guidelines - api - policy - contributing - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history + user/index + reference/index + contributor/index -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`modindex` * :ref:`search` diff --git a/doc/source/api.rst b/doc/source/reference/index.rst index 02095f7..99ead69 100644 --- a/doc/source/api.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,8 @@ -===== - API -===== +.. _api: + +=============== + oslo.i18n API +=============== oslo_i18n ========= diff --git a/doc/source/guidelines.rst b/doc/source/user/guidelines.rst index 9ed87fe..faa0a97 100644 --- a/doc/source/guidelines.rst +++ b/doc/source/user/guidelines.rst @@ -12,8 +12,8 @@ to the user. Those do not need to be translated. .. seealso:: - * :doc:`usage` - * :doc:`api` + * :ref:`usage` + * :ref:`api` Gettext Contextual Form and Plural Form ======================================= 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..b8745ec --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,11 @@ +================= + Using oslo.i18n +================= + +.. toctree:: + :maxdepth: 2 + + usage + guidelines + history + diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst index e80816e..d26acd1 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst @@ -1,3 +1,5 @@ +.. _usage: + ===================================================== How to Use oslo.i18n in Your Application or Library ===================================================== |