From 9b5c6952180870608c6c5dcd1fd06a3cd32de4c2 Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Wed, 3 Jul 2013 19:20:56 +0200 Subject: [PATCH] doc: Added API documentation --- doc/api/babel.core.rst | 6 ++++++ doc/api/babel.dates.rst | 6 ++++++ doc/api/babel.localedata.rst | 6 ++++++ doc/api/babel.messages.catalog.rst | 6 ++++++ doc/api/babel.messages.checkers.rst | 6 ++++++ doc/api/babel.messages.extract.rst | 6 ++++++ doc/api/babel.messages.frontend.rst | 6 ++++++ doc/api/babel.messages.mofile.rst | 6 ++++++ doc/api/babel.messages.plurals.rst | 6 ++++++ doc/api/babel.messages.pofile.rst | 6 ++++++ doc/api/babel.messages.rst | 6 ++++++ doc/api/babel.numbers.rst | 6 ++++++ doc/api/babel.support.rst | 6 ++++++ doc/api/babel.util.rst | 6 ++++++ doc/conf.py | 2 +- doc/index.rst | 22 +++++++++++++++++++++- 16 files changed, 106 insertions(+), 2 deletions(-) create mode 100644 doc/api/babel.core.rst create mode 100644 doc/api/babel.dates.rst create mode 100644 doc/api/babel.localedata.rst create mode 100644 doc/api/babel.messages.catalog.rst create mode 100644 doc/api/babel.messages.checkers.rst create mode 100644 doc/api/babel.messages.extract.rst create mode 100644 doc/api/babel.messages.frontend.rst create mode 100644 doc/api/babel.messages.mofile.rst create mode 100644 doc/api/babel.messages.plurals.rst create mode 100644 doc/api/babel.messages.pofile.rst create mode 100644 doc/api/babel.messages.rst create mode 100644 doc/api/babel.numbers.rst create mode 100644 doc/api/babel.support.rst create mode 100644 doc/api/babel.util.rst diff --git a/doc/api/babel.core.rst b/doc/api/babel.core.rst new file mode 100644 index 00000000..acc63aff --- /dev/null +++ b/doc/api/babel.core.rst @@ -0,0 +1,6 @@ +========== +babel.core +========== + +.. automodule:: babel.core + :members: diff --git a/doc/api/babel.dates.rst b/doc/api/babel.dates.rst new file mode 100644 index 00000000..639b2794 --- /dev/null +++ b/doc/api/babel.dates.rst @@ -0,0 +1,6 @@ +=========== +babel.dates +=========== + +.. automodule:: babel.dates + :members: diff --git a/doc/api/babel.localedata.rst b/doc/api/babel.localedata.rst new file mode 100644 index 00000000..bdca4265 --- /dev/null +++ b/doc/api/babel.localedata.rst @@ -0,0 +1,6 @@ +================ +babel.localedata +================ + +.. automodule:: babel.localedata + :members: diff --git a/doc/api/babel.messages.catalog.rst b/doc/api/babel.messages.catalog.rst new file mode 100644 index 00000000..b6edb49e --- /dev/null +++ b/doc/api/babel.messages.catalog.rst @@ -0,0 +1,6 @@ +====================== +babel.messages.catalog +====================== + +.. automodule:: babel.messages.catalog + :members: diff --git a/doc/api/babel.messages.checkers.rst b/doc/api/babel.messages.checkers.rst new file mode 100644 index 00000000..2d58631e --- /dev/null +++ b/doc/api/babel.messages.checkers.rst @@ -0,0 +1,6 @@ +======================= +babel.messages.checkers +======================= + +.. automodule:: babel.messages.checkers + :members: diff --git a/doc/api/babel.messages.extract.rst b/doc/api/babel.messages.extract.rst new file mode 100644 index 00000000..e846f380 --- /dev/null +++ b/doc/api/babel.messages.extract.rst @@ -0,0 +1,6 @@ +====================== +babel.messages.extract +====================== + +.. automodule:: babel.messages.extract + :members: diff --git a/doc/api/babel.messages.frontend.rst b/doc/api/babel.messages.frontend.rst new file mode 100644 index 00000000..0ca45cae --- /dev/null +++ b/doc/api/babel.messages.frontend.rst @@ -0,0 +1,6 @@ +======================= +babel.messages.frontend +======================= + +.. automodule:: babel.messages.frontend + :members: diff --git a/doc/api/babel.messages.mofile.rst b/doc/api/babel.messages.mofile.rst new file mode 100644 index 00000000..57919e73 --- /dev/null +++ b/doc/api/babel.messages.mofile.rst @@ -0,0 +1,6 @@ +===================== +babel.messages.mofile +===================== + +.. automodule:: babel.messages.mofile + :members: diff --git a/doc/api/babel.messages.plurals.rst b/doc/api/babel.messages.plurals.rst new file mode 100644 index 00000000..38ee7c6d --- /dev/null +++ b/doc/api/babel.messages.plurals.rst @@ -0,0 +1,6 @@ +====================== +babel.messages.plurals +====================== + +.. automodule:: babel.messages.plurals + :members: diff --git a/doc/api/babel.messages.pofile.rst b/doc/api/babel.messages.pofile.rst new file mode 100644 index 00000000..8d3cc3f4 --- /dev/null +++ b/doc/api/babel.messages.pofile.rst @@ -0,0 +1,6 @@ +===================== +babel.messages.pofile +===================== + +.. automodule:: babel.messages.pofile + :members: diff --git a/doc/api/babel.messages.rst b/doc/api/babel.messages.rst new file mode 100644 index 00000000..4bc9ef12 --- /dev/null +++ b/doc/api/babel.messages.rst @@ -0,0 +1,6 @@ +============== +babel.messages +============== + +.. automodule:: babel.messages + :members: diff --git a/doc/api/babel.numbers.rst b/doc/api/babel.numbers.rst new file mode 100644 index 00000000..8ac643da --- /dev/null +++ b/doc/api/babel.numbers.rst @@ -0,0 +1,6 @@ +============= +babel.numbers +============= + +.. automodule:: babel.numbers + :members: diff --git a/doc/api/babel.support.rst b/doc/api/babel.support.rst new file mode 100644 index 00000000..58d0b987 --- /dev/null +++ b/doc/api/babel.support.rst @@ -0,0 +1,6 @@ +============= +babel.support +============= + +.. automodule:: babel.support + :members: diff --git a/doc/api/babel.util.rst b/doc/api/babel.util.rst new file mode 100644 index 00000000..fa594703 --- /dev/null +++ b/doc/api/babel.util.rst @@ -0,0 +1,6 @@ +========== +babel.util +========== + +.. automodule:: babel.util + :members: diff --git a/doc/conf.py b/doc/conf.py index 4a67d56e..9e3d3065 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,7 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('..')) sys.path.append(os.path.abspath('_themes')) # -- General configuration ----------------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index 785e4169..8be5b741 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -23,4 +23,24 @@ web-based applications. cmdline setup support - api/index + +API Reference +------------- + +.. toctree:: + :maxdepth: 1 + + api/babel.core + api/babel.dates + api/babel.localedata + api/babel.messages + api/babel.messages.catalog + api/babel.messages.checkers + api/babel.messages.extract + api/babel.messages.frontend + api/babel.messages.mofile + api/babel.messages.plurals + api/babel.messages.pofile + api/babel.numbers + api/babel.support + api/babel.util -- 2.47.2