docs: sphinx-intl and added English translation

docs/backends.rst

@@ -8,10 +8,10 @@ Usar un backend específico
 
 .. code-block:: python
 
-    import bormeparser
+    import bormeparser.backends.pypdf2
 
-    parser = bormeparser.backend.pypdf2.parser()
-    parser.download(...)
+    parser = bormeparser.backends.pypdf2.parser.PyPDF2Parser('pdf/BORME-A-2015-27-10.pdf')
+    borme = parser.parse()
 
 
 Implementar un nuevo backend

docs/conf.py

@@ -58,7 +58,7 @@
 # The short X.Y version.
 version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -269,7 +269,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'bormeparser', 'bormeparser Documentation',
-   author, 'bormeparser', 'One line description of project.',
+   author, 'bormeparser', 'A Python library for parsing BORME files (Boletín Oficial del Registro Mercantil in Spain).',
    'Miscellaneous'),
 ]
 
@@ -354,3 +354,7 @@
 
 # If false, no index is generated.
 #epub_use_index = True
+
+#### i18n
+locale_dirs = ['locale/']
+gettext_compact = False

docs/locale/en/LC_MESSAGES/backends.po

@@ -0,0 +1,35 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:35+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../backends.rst:2
+msgid "Backends"
+msgstr ""
+
+#: ../../backends.rst:4
+msgid ""
+"Bormeparser soporta diferentes backends a la hora de parsear los archivos "
+"PDF."
+msgstr "Bormeparser supports differents backend when parsing PDF files."
+
+#: ../../backends.rst:7
+msgid "Usar un backend específico"
+msgstr "Using a specific backend"
+
+#: ../../backends.rst:18
+msgid "Implementar un nuevo backend"
+msgstr "Implement a new backend"
+
+#: ../../backends.rst:20
+msgid "base.py"
+msgstr ""

docs/locale/en/LC_MESSAGES/changelog.po

@@ -0,0 +1,25 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:35+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../changelog.rst:2
+msgid "Lista de cambios"
+msgstr "Changelog"
+
+#: ../../changelog.rst:5
+msgid "0.1"
+msgstr ""
+
+#: ../../changelog.rst:6
+msgid "TBD...."
+msgstr ""

docs/locale/en/LC_MESSAGES/contribution.po

@@ -0,0 +1,29 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:36+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../contribution.rst:2
+msgid "Contribuir"
+msgstr "Contribute"
+
+#: ../../contribution.rst:4
+msgid ""
+"Puedes mandar tus Pull Requests directamente a través de GitHub, donde "
+"también hay una lista de issues puedes ayudar a arreglar."
+msgstr ""
+"You can send your Pull Requests directly through GitHub. There is also "
+"available a list of issues there that you can help fixing."
+
+#: ../../contribution.rst:7
+msgid "https://github.com/PabloCastellano/bormeparser/issues"
+msgstr ""

docs/locale/en/LC_MESSAGES/index.po

@@ -0,0 +1,37 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:30+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../index.rst:7
+msgid "¡Bienvenido a la documentación de bormeparser!"
+msgstr "Welcome to the bormeparser documentation!"
+
+#: ../../index.rst:9
+msgid "Contenido:"
+msgstr "Contents:"
+
+#: ../../index.rst:22
+msgid "Indices and tables"
+msgstr "Indices and tables"
+
+#: ../../index.rst:24
+msgid ":ref:`genindex`"
+msgstr ""
+
+#: ../../index.rst:25
+msgid ":ref:`modindex`"
+msgstr ""
+
+#: ../../index.rst:26
+msgid ":ref:`search`"
+msgstr ""

docs/locale/en/LC_MESSAGES/installation.po

@@ -0,0 +1,29 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:37+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../installation.rst:2
+msgid "Instalación"
+msgstr "Installation"
+
+#: ../../installation.rst:4
+msgid "Puedes obtener bormeparser sencillamente desde PyPI::"
+msgstr "You can obtain bormeparser easily from PyPI::"
+
+#: ../../installation.rst:8
+msgid ""
+"O si lo prefieres, puedes clonar el repositorio e instalarlo desde ahí, "
+"compilando previamente sus dependencias::"
+msgstr ""
+"And you can also clone the repository and install it from there, compiling "
+"beforehand its dependencies::"

docs/locale/en/LC_MESSAGES/introduction.po

@@ -0,0 +1,77 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:33+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../introduction.rst:2
+msgid "Introducción"
+msgstr "Introduction"
+
+#: ../../introduction.rst:4
+msgid ""
+"**bormeparser** es una librería de Python para parsear los archivos del "
+"BORME (Boletín Oficial del Registro Mercantil en España)."
+msgstr ""
+"**bormeparser** is a Python library for parsing BORME files (Boletín Oficial "
+"del Registro Mercantil in Spain)."
+
+#: ../../introduction.rst:7
+msgid "Qué es BORME"
+msgstr "What is BORME"
+
+#: ../../introduction.rst:9
+msgid ""
+"El **Boletín Oficial del Registro Mercantil** es un documento publicado "
+"diariamente por el Registro Mercantil Central (RMC) en España que contiene "
+"un listado de las últimas sociedades creadas y disueltas así como otros "
+"datos que las empresas están obligadas a comunicar."
+msgstr ""
+"The **Boletín Oficial del Registro Mercantil** (Spanish for *Official "
+"Mercantile Register Bulletin*) is a document published daily by Registro "
+"Mercantil Central (RMC) in Spain which contains newly created societies, "
+"societies that have broken up, and some other data the companies must "
+"communicate."
+
+#: ../../introduction.rst:13
+msgid ""
+"La librería aprovecha que desde la aprobación de `esta ley`_, desde el año "
+"2009 el BORME se publica también en formato electrónico con la misma validez "
+"que su versión en papel."
+msgstr ""
+"This library takes advantage of the electronic format of BORMEs that are "
+"published since 2009 due to `esta ley`_."
+
+#: ../../introduction.rst:16
+msgid "Los BORMEs se publican en http://boe.es/diario_borme/."
+msgstr "BORMEs are published at http://boe.es/diario_borme/."
+
+#: ../../introduction.rst:18
+msgid ""
+"Desgraciadamente debido al acuerdo actual con el Registro Mercantil, no "
+"pueden publicar todos los datos en un formato útil y reutilizable como XML o "
+"JSON y los datos más interesantes están solo disponibles en los archivos PDF."
+msgstr ""
+"Unfortunately due to some agreements with Mercantile Register they are not "
+"allowedto publish all data in some useful format like XML or JSON and the "
+"most interesting information is only available in PDF files."
+
+#: ../../introduction.rst:21
+msgid "Puedes leer más sobre ello en:"
+msgstr "You can read more about it on:"
+
+#: ../../introduction.rst:23
+msgid ""
+"Wikipedia: `https://es.wikipedia.org/wiki/"
+"Boletín_Oficial_del_Registro_Mercantil`_"
+msgstr ""
+"Wikipedia: `https://es.wikipedia.org/wiki/"
+"Boletín_Oficial_del_Registro_Mercantil`_"

docs/locale/en/LC_MESSAGES/tutorial.po

@@ -0,0 +1,60 @@
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: bormeparser 0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-06-28 19:26+0200\n"
+"PO-Revision-Date: 2015-06-28 19:40+0100\n"
+"Last-Translator: Pablo Castellano <pablo@anche.no>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.5.4\n"
+
+#: ../../tutorial.rst:2
+msgid "Tutorial"
+msgstr ""
+
+#: ../../tutorial.rst:5
+msgid "Uso básico"
+msgstr "Basic usage"
+
+#: ../../tutorial.rst:7
+msgid ""
+"bormeparser proporciona distintas funciones para tratar los archivos del "
+"BORME."
+msgstr ""
+"bormeparser provides diverse several functions to deal with BORME files."
+
+#: ../../tutorial.rst:9
+msgid "Empezamos con las funciones para generar las urls de descarga:"
+msgstr "We begin with the basic functions used to generate the download URLs:"
+
+#: ../../tutorial.rst:25
+msgid ""
+"Pero podemos usar otras funciones para descargar el BORME directamente de "
+"ese día:"
+msgstr ""
+"But we can use other functions to download BORME directly from one specific "
+"day:"
+
+#: ../../tutorial.rst:35
+msgid ""
+"Si no ha habido ningún error (problema de conexión, el BORME de esa fecha no "
+"existe, ...) la variable borme es una instancia de Borme:"
+msgstr ""
+"If it succeeded (no connection problems, BORME existed, ...) the borme "
+"variable is now an instance of Borme:"
+
+#: ../../tutorial.rst:43
+msgid ""
+"Para conocer la url de un PDF, bormeparser internamente descarga el archivo "
+"XML del día y ahí encuentra la ruta. Podemos obtener dicho archivo XML así:"
+msgstr ""
+"To know the URL of a PDF, bormeparser internally downloads the XML file of "
+"the day and finds the path there. We can obtain that XML file like this:"
+
+#: ../../tutorial.rst:53
+msgid "Uso avanzado"
+msgstr "Advanced usage"

requirements/documentation.txt

@@ -1,19 +1,19 @@
 alabaster==0.7.6
 argh==0.26.1
 Babel==1.3
-backports.ssl-match-hostname==3.4.0.2
-certifi==2015.4.28
 docutils==0.12
 Jinja2==2.7.3
 livereload==2.4.0
 MarkupSafe==0.23
 pathtools==0.1.2
+polib==1.0.6
 Pygments==2.0.2
 pytz==2015.4
 PyYAML==3.11
 snowballstemmer==1.2.0
 Sphinx==1.3.1
 sphinx-autobuild==0.5.2
+sphinx-intl==0.9.5
 sphinx-rtd-theme==0.1.8
 tornado==4.2
 watchdog==0.8.3