Welcome to Demo project for sphinx-intl's documentation!
========================================================
We will use this to demo the usage of `sphinx-intl`_.
Make sure you make installed all the required packages:
.. code-block:: bash
pip install -r requirements.txt
Then try to write some more pages.
Contents:
.. toctree::
:maxdepth: 2
intro
api
index.rst
Intro
=====
Sphinx
------
**Sphinx** is an excellent Python documentation generator. From |Wikipedia|_,
Sphinx is a documentation generator, heavily used (and written) by the
Python community. It's also written in Python (a programming language); but
used by many other environments.
.. |Wikipedia| replace:: *Wikipedia*
.. _Wikipedia: https://en.wikipedia.org/wiki/Sphinx_%28documentation_generator%29
It use reStructuredText (rst) for as the markup language for documents. An
rst document usually looks like:
intro.rst
GNU ``gettext`` API
===================
Extract some docstring of :mod:`gettext` here (see the `full module description`_).
.. function:: gettext(message)
Return the localized translation of *message*, based on the current global
domain, language, and locale directory. This function is usually aliased as
:func:`_` in the local namespace (see examples below).
.. _full module description: https://docs.python.org/3.5/library/gettext.html
Here's an example of typical usage for this API:
.. code-block:: python3
import gettext
gettext.bindtextdomain('myapplication', '/path/to/my/language/directory')
# ...
