rearrange the documentation to fit into the new standard layout

Change-Id: Ibe6548b444a8f030ea7ba034b7d63622e32d3917 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:42:18 -04:00 · 2017-06-28 12:42:18 -04:00 · 01dead7bdd
commit 01dead7bdd
parent 1cf2f426ce
10 changed files with 35 additions and 25 deletions
--- a/doc/source/contributor/contributing.rst
+++ b/doc/source/contributor/contributing.rst
@ -2,4 +2,4 @@
 Contributing
 ==============

-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -0,0 +1,9 @@
+===========================
+ Contributing to oslo.i18n
+===========================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributing
+   policy
--- a/doc/source/contributor/policy.rst
+++ b/doc/source/contributor/policy.rst
--- a/doc/source/history.rst
+++ b/doc/source/history.rst
@ -1 +0,0 @@
-.. include:: ../../ChangeLog
--- 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
+   user/index
+   reference/index
+   contributor/index

-Release Notes
-=============
-
-.. toctree::
-   :maxdepth: 1
-
-   history
-
-Indices and tables
-==================
+.. rubric:: Indices and tables

 * :ref:`modindex`
 * :ref:`search`
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -1,6 +1,8 @@
-=====
- API
-=====
+.. _api:
+
+===============
+ oslo.i18n API
+===============

 oslo_i18n
 =========
--- a/doc/source/user/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
 =======================================
--- a/doc/source/user/history.rst
+++ b/doc/source/user/history.rst
@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@ -0,0 +1,11 @@
+=================
+ Using oslo.i18n
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   guidelines
+   history
+
--- a/doc/source/user/usage.rst
+++ b/doc/source/user/usage.rst
@ -1,3 +1,5 @@
+.. _usage:
+
 =====================================================
 How to Use oslo.i18n in Your Application or Library
 =====================================================