openstack/oslo.i18n
Code Issues Proposed changes

rearrange the documentation to fit into the new standard layout

Browse Source 
Change-Id: Ibe6548b444a8f030ea7ba034b7d63622e32d3917
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-28 12:42:18 -04:00
parent 1cf2f426ce
commit 01dead7bdd
10 changed files with 35 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

9
doc/source/contributor/index.rst Normal file
View File

@ -0,0 +1,9 @@
===========================
Contributing to oslo.i18n
===========================
.. toctree::
:maxdepth: 2
contributing
policy

0
doc/source/policy.rst → doc/source/contributor/policy.rst
View File

1
doc/source/history.rst
View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

22
doc/source/index.rst
View File

@ -6,28 +6,14 @@ The oslo.i18n library contain utilities for working with
internationalization (i18n) features, especially translation for text internationalization (i18n) features, especially translation for text
strings in an application or library. strings in an application or library.
Contents
========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
usage user/index
guidelines reference/index
api contributor/index
policy
contributing
Release Notes .. rubric:: Indices and tables
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`

8
doc/source/api.rst → doc/source/reference/index.rst
View File

@ -1,6 +1,8 @@
===== .. _api:
API
===== ===============
oslo.i18n API
===============
oslo_i18n oslo_i18n
========= =========

4
doc/source/guidelines.rst → doc/source/user/guidelines.rst
View File

@ -12,8 +12,8 @@ to the user. Those do not need to be translated.
.. seealso:: .. seealso::
* :doc:`usage` * :ref:`usage`
* :doc:`api` * :ref:`api`
Gettext Contextual Form and Plural Form Gettext Contextual Form and Plural Form
======================================= =======================================

1
doc/source/user/history.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../../ChangeLog

11
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,11 @@
=================
Using oslo.i18n
=================
.. toctree::
:maxdepth: 2
usage
guidelines
history

2
doc/source/usage.rst → doc/source/user/usage.rst
View File

@ -1,3 +1,5 @@
.. _usage:
===================================================== =====================================================
How to Use oslo.i18n in Your Application or Library How to Use oslo.i18n in Your Application or Library
===================================================== =====================================================