mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
Removed Sphinx and Babel command class from setup.py file and added a TRANSLATE file for more details about translate the package
This commit is contained in:
parent
8f21fd0c0f
commit
3329e09479
@ -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
|
||||
=========
|
||||
|
||||
|
52
TRANSLATE.rst
Normal file
52
TRANSLATE.rst
Normal file
@ -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
|
||||
|
||||
|
13
setup.py
13
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
|
||||
},
|
||||
)
|
||||
|
Loading…
Reference in New Issue
Block a user