summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2017-12-16 07:40:29 -0600
committerJason Madden <jamadden@gmail.com>2017-12-16 07:40:29 -0600
commit89927bff938e8d11cd7c8acd705e8ebef43b6b1c (patch)
tree8373c827aa50a555ab210d183ee10f80f0884db8 /docs
parente924eea24f6d9b635a4b3370d90bb1ce7869b944 (diff)
downloadzope-i18n-89927bff938e8d11cd7c8acd705e8ebef43b6b1c.tar.gz
Remove _compat module and _u function in favor of native unicode literals and project gardeningdrop-33
- DRY with dependencies - Enable coveralls.io and add a coverage tox environment - A few tiny changes to increase coverage, but we're not at 100% - Enable testing sphinx docs for all versions - Publish CHANGES.rst on RTD - Modern tox.ini and .travis.yml - Travis was still testing 3.3 and not testing 3.6. - Remove 'level' qualifiers from XML parsing and ZCML test cases. They add about 2s to run the tests, but they're important; see #13. That extra time gets lost in the amount of time it takes to spin tox anyway.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst25
-rw-r--r--docs/changelog.rst1
-rw-r--r--docs/conf.py14
-rw-r--r--docs/index.rst17
4 files changed, 28 insertions, 29 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 6639431..706976e 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,5 +1,6 @@
-:mod:`zope.i18n` API Reference
-===============================
+=========================
+ zope.i18n API Reference
+=========================
.. testsetup::
@@ -7,37 +8,33 @@
from zope.i18n import translate
zope.i18n
----------
+=========
.. automodule:: zope.i18n
- :members:
zope.i18n.compile
------------------
+=================
.. automodule:: zope.i18n.compile
- :members:
zope.i18n.config
-----------------
+================
.. automodule:: zope.i18n.config
- :members:
zope.i18n.format
-----------------
+================
.. automodule:: zope.i18n.format
- :members:
zope.i18n.gettextmessagecatalog
--------------------------------
+===============================
.. automodule:: zope.i18n.gettextmessagecatalog
- :members:
zope.i18n.interfaces
---------------------
+====================
.. automodule:: zope.i18n.interfaces
- :members:
+
+.. automodule:: zope.i18n.interfaces.locales
diff --git a/docs/changelog.rst b/docs/changelog.rst
new file mode 100644
index 0000000..d9e113e
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGES.rst
diff --git a/docs/conf.py b/docs/conf.py
index ecc5437..0ed66d4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,7 +11,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os, pkg_resources
+import sys
+import os
+import pkg_resources
# 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
@@ -29,6 +31,8 @@ extensions = [
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode',
+ 'repoze.sphinx.autointerface',
]
# Add any paths that contain templates here, relative to this directory.
@@ -45,7 +49,7 @@ master_doc = 'index'
# General information about the project.
project = u'zope.i18n'
-copyright = u'2010, Zope Foundation and Contributors'
+copyright = u'2010-2017, Zope Foundation and Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -74,7 +78,7 @@ release = rqmt.version
exclude_trees = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+default_role = 'obj'
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
@@ -203,3 +207,7 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
+
+autodoc_default_flags = ['members', 'show-inheritance']
+autoclass_content = 'both'
+autodoc_member_order = 'bysource'
diff --git a/docs/index.rst b/docs/index.rst
index 2ca2cc2..e8dbcf0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,14 +1,5 @@
-:mod:`zope.18n` Documentation
-===============================
-This package implements several APIs related to internationalization and
-localization.
-
-* Locale objects for all locales maintained by the ICU project.
-
-* Gettext-based message catalogs for message strings.
-
-* Locale discovery for Web-based requests.
+.. include:: ../README.rst
Contents:
@@ -16,9 +7,11 @@ Contents:
:maxdepth: 2
api
+ changelog
-Indices and tables
-==================
+====================
+ Indices and tables
+====================
* :ref:`genindex`
* :ref:`modindex`