From 3329e09479cf8249cbe2fbff494b2022f3aebd2f Mon Sep 17 00:00:00 2001 From: "Leonardo J. Caballero G" Date: Mon, 3 Apr 2017 10:40:42 -0400 Subject: [PATCH] Removed Sphinx and Babel command class from setup.py file and added a TRANSLATE file for more details about translate the package --- README.rst | 6 ++++++ TRANSLATE.rst | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++ setup.py | 13 ------------- 3 files changed, 58 insertions(+), 13 deletions(-) create mode 100644 TRANSLATE.rst diff --git a/README.rst b/README.rst index 8b952af1..a9159628 100644 --- a/README.rst +++ b/README.rst @@ -99,6 +99,12 @@ You can currently add the following: * ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL * ``:gitlab_url:`` This will force the "Edit on GitLab" to the configured URL +Translations +============ + +You can help to translate the Read the Docs Sphinx Theme, +please check out the ``TRANSLATE.rst`` file for more details. + Changelog ========= diff --git a/TRANSLATE.rst b/TRANSLATE.rst new file mode 100644 index 00000000..50086a6c --- /dev/null +++ b/TRANSLATE.rst @@ -0,0 +1,52 @@ +****************** +Translation Guide +****************** + +.. contents:: + +You can help to translate the Read the Docs Sphinx Theme. + +Languages availables: + +- Spanish contributed by Leonardo J. Caballero G. +- Your Language by YOUR NAME. + +Installation +============ + +For translate the Read the Docs Sphinx Theme you need install the following packages: + +.. code:: bash + + $ pip install babel Jinja2 + +Distutils/Setuptools Integration +================================ + +You can configure different parts of the theme. + +Compile catalog +--------------- + +For compile catalog of the theme's project-wide is available. +More options please, check out http://babel.pocoo.org/en/latest/setup.html#compile-catalog + +Extract messages +---------------- + +It is available the option to extract messages to translate. +More options please, check out http://babel.pocoo.org/en/latest/setup.html#extract-messages + +init catalog +------------ + +It is available the option to init catalog. +More options please, check out http://babel.pocoo.org/en/latest/setup.html#init-catalog + +update catalog +-------------- + +It is available the option to init catalog. +More options please, check out http://babel.pocoo.org/en/latest/setup.html#update-catalog + + diff --git a/setup.py b/setup.py index 01c8dbc3..e38fb528 100644 --- a/setup.py +++ b/setup.py @@ -5,10 +5,6 @@ """ -try: - from babel.messages import frontend as babel -except ImportError: - pass from setuptools import setup from sphinx_rtd_theme import __version__ @@ -48,13 +44,4 @@ setup( 'Topic :: Documentation', 'Topic :: Software Development :: Documentation', ], - install_requires= [ - 'Sphinx>=1.4.1', - ], - cmdclass = { - 'compile_catalog': babel.compile_catalog, - 'extract_messages': babel.extract_messages, - 'init_catalog': babel.init_catalog, - 'update_catalog': babel.update_catalog - }, )