diff --git a/documentation/hosting-tools/sphinx-python-package-documentation-tools.md b/documentation/hosting-tools/sphinx-python-package-documentation-tools.md index 1e1f54d9..ac99959b 100644 --- a/documentation/hosting-tools/sphinx-python-package-documentation-tools.md +++ b/documentation/hosting-tools/sphinx-python-package-documentation-tools.md @@ -46,7 +46,7 @@ and themes. A few examples include: * You can apply documentation themes for quick generation of beautiful documentation. * You can [automatically create documentation for your package's functions and classes (the package's API) from docstrings in your code using the autodoc extension](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) * You can [run and test code examples in your docstrings using the doctest extension](https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html) -* While Sphinx natively supports the `rST` syntax. You can add custom syntax parsers to support easier-to-write syntax using tools such as [the MyST parser](https://myst-parser.readthedocs.io/). +* While Sphinx natively supports the `rST` syntax, you can add custom syntax parsers to support easier-to-write syntax using tools such as [the MyST parser](https://myst-parser.readthedocs.io/). ### Commonly used Sphinx themes diff --git a/locales/es/LC_MESSAGES/documentation.po b/locales/es/LC_MESSAGES/documentation.po index b5493ae5..1357f888 100644 --- a/locales/es/LC_MESSAGES/documentation.po +++ b/locales/es/LC_MESSAGES/documentation.po @@ -22,7 +22,7 @@ msgstr "" #: ../../documentation/hosting-tools/intro.md:1 msgid "Tools to Build and Host your Documentation" -msgstr "" +msgstr "Herramientas para hacer y servir tu documentación" #: ../../documentation/hosting-tools/intro.md:3 msgid "" @@ -31,6 +31,10 @@ msgid "" "[mkdocs](https://www.mkdocs.org/) for documentation. It is up to you to " "use the platform that you prefer for your documentation!" msgstr "" +"Sphinx es la herramienta más común para construir documentación en el " +"ecosistema de Python. Sin embargo, algunos mantenedores están usando " +"herramientas como [mkdocs](https://www.mkdocs.org/) para generar la documentación. ¡Es tu " +"decisión usar la herramienta que prefieras para tu documentación!" #: ../../documentation/hosting-tools/intro.md:8 msgid "" @@ -38,20 +42,26 @@ msgid "" "documentation. We talk about various syntax options that you can use when" " writing Sphinx documentation including mySt and rST." msgstr "" +"En esta sección introducimos Sphinx como herramienta para construir " +"documentación. Hablamos sobre varias opciones de sintaxis que puedes usar " +"para escribir documentación de Sphinx incluyendo myST and rST." #: ../../documentation/hosting-tools/intro.md:12 msgid "" "We also talk about ways to publish your documentation online and Sphinx " "tools that might help you optimize your documentation website." msgstr "" +"Hablamos también sobre methodos para publicar tu documentación en línea " +"y herramientas de Sphinx que pueda ayudarte optimizar tu sitio web para " +"documentación." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:1 msgid "Documentation syntax: markdown vs. myST vs. rst syntax to create your docs" -msgstr "" +msgstr "Sintaxis de documentación: markdown vs. myST vs. rst." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:3 msgid "There are three commonly used syntaxes for creating Python documentation:" -msgstr "" +msgstr "Hay tres sintaxis comúnes para crear documentación en Python:" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:4 msgid "" @@ -63,6 +73,13 @@ msgid "" " blocks and other custom elements to your documentation, you will need to" " use either **myST** or **rST**." msgstr "" +"[markdown](https://www.markdownguide.org/): Markdown es una sintaxis de texto plano " +"que es fácil aprender. Es la sintaxis por defecto para Jupyter Notebooks. Hay " +"herramientas que puedes usar con Sphinx que permiten renderizar " +"markdown como HTML. Sin embargo, usar markdown para escribir documentación " +"tiene limitaciones. Por ejemplo, si deseas añadir referencias, tarjetas " +"de colores, u otros elementos personalizados a tu documentación, necesitarás " +"usar **myST** o **rST**." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:8 msgid "" @@ -73,6 +90,12 @@ msgid "" "the top as a favorite for documentation given the flexibility that it " "allows." msgstr "" +"[rST (ReStructured Text):](https://www.sphinx-" +"doc.org/en/master/usage/restructuredtext/basics.html). **rST** es la sintaxis " +"nativa para Sphinx. rST ha sido la sintaxis por defecto para documentación " +"durante muchos años. Sin embargo, recientemente myST ha aumentado en popularidad " +"para convertirse en la herramienta favorita para documentación gracias a su +flexibilidad." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:9 msgid "" @@ -82,44 +105,59 @@ msgid "" "many because it offers both the rich functionality of rST combined with a" " simple-to-write markdown syntax." msgstr "" +"[myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST es una " +"combinación de `markdown` y `rST`. Es una opción buena si te sientes " +"cómodo escribiendo markdown. `myst` es preferido por mucha gente dado que " +"ofrece la amplia funcionalidad de rST en combinación con la sintaxis " +"fácil de markdown." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:12 msgid "" "While you can chose to use any of the syntaxes listed above, we suggest " "using `myST` because:" msgstr "" +"Aunque puedas elegir cualquiera sintaxis listado arriba, sugerimos que " +"usas `myST` porque:" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:15 msgid "It is a simpler syntax and thus easier to learn;" -msgstr "" +msgstr "Es una sintaxis más simple y, por lo tanto más facil de aprender;" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:16 msgid "" "The above simplicity will make it easier for more people to contribute to" " your documentation." msgstr "" +"Esta simplicidad hará más fácil que más gente contribuya a tu " +"documentación." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:17 msgid "" "Most of your core Python package text files, such as your README.md file," " are already in `.md` format" msgstr "" +"La mayoría de los archivos de texto de tus paquetes principales de Python, " +"como el archivo README.md, ya están en formato `.md`." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:18 msgid "" "`GitHub` and `Jupyter Notebooks` support markdown thus it's more widely " "used in the scientific ecosystem." msgstr "" +"`GitHub` y `Jupyter Notebooks` apoyan markdown, por lo que son más " +"utilizados en el ecosistema científico." #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:22 msgid "" "If you are on the fence about myST vs rst, you might find that **myST** " "is easier for more people to contribute to." msgstr "" +"Si no estás seguro sobre si utilizar myST o rst, puede que encuentres que " +"**myST** es más fácil para contribuciones de más gente." #: ../../documentation/hosting-tools/publish-documentation-online.md:1 msgid "How to publish your Python package documentation online" -msgstr "" +msgstr "Cómo publicar la documentación de tu paquete de Python en línea" #: ../../documentation/hosting-tools/publish-documentation-online.md:3 msgid "" @@ -127,50 +165,64 @@ msgid "" "documentation. Two free and commonly used ways to quickly create a " "documentation website hosting environment are below." msgstr "" - +"Sugerimos que utilizas un servicio de hosting para la documentación de tu " +"paquete de Python. Abajo encontrarás dos métodos gratuitos y comúnes para servir " +"tu documentación en un sitio web." #: ../../documentation/hosting-tools/publish-documentation-online.md:7 msgid "" "You can host your documentation yourself using [GitHub " "Pages](https://pages.github.com/) or another online hosting service." msgstr "" +"Puedes servir tu documentación utilizando [GitHub " +"Pages](https://pages.github.com/) u otro servicio de hosting." #: ../../documentation/hosting-tools/publish-documentation-online.md:8 msgid "" "You can host your documentation using [Read the " "Docs](https://readthedocs.org/)." msgstr "" +"Puedes servir tu documentación utilizando [Read the " +"Docs](https://readthedocs.org/)." #: ../../documentation/hosting-tools/publish-documentation-online.md:10 msgid "What is Read the Docs ?" -msgstr "" +msgstr "¿Qué es Read the Docs?" #: ../../documentation/hosting-tools/publish-documentation-online.md:11 msgid "" "[Read the Docs](https://readthedocs.org/) is a documentation hosting " "service that supports publishing your project's documentation." msgstr "" +"[Read the Docs](https://readthedocs.org/) es un servicio de hosting " +"que permite publicar la documentación de tu proyecto." #: ../../documentation/hosting-tools/publish-documentation-online.md:13 msgid "" "Read the Docs is a fully featured, free, documentation hosting service. " "Some of its many features include:" msgstr "" +"Read the Docs es un servicio de hosting de documentación gratuito. Algunas de " +"sus funcionalidades son:" #: ../../documentation/hosting-tools/publish-documentation-online.md:16 msgid "" "Is free to host your documentation (but there are also paid tiers if you " "wish to customize hosting)" msgstr "" +"Permite servir tu documentación de forma gratuita (pero hay opciones de pago si deseas " +"personalizar el hosting)" #: ../../documentation/hosting-tools/publish-documentation-online.md:17 msgid "Automates building your documentation" -msgstr "" +msgstr "Construye tu documentación automáticamente" #: ../../documentation/hosting-tools/publish-documentation-online.md:18 msgid "" "Allows you to turn on integration with pull requests where you can view " "documentation build progress (success vs failure)." msgstr "" +"Te permite integrar solicitudes de cambio para ver el progreso de construcción " +"de la documentación (éxito vs error)" #: ../../documentation/hosting-tools/publish-documentation-online.md:19 msgid "" @@ -178,20 +230,24 @@ msgid "" "older tagged versions of the docs if they are using older versions of " "your package." msgstr "" +"Permite versionar tu documentación, lo que permite a los usuarios acceder a " +"versiones antiguas de la documentación en caso de que las estén usando en su paquete. " #: ../../documentation/hosting-tools/publish-documentation-online.md:20 msgid "Supports downloading of documentation in PDF and other formats." -msgstr "" +msgstr "Permite descargar la documentación en PDF y otros formatos." #: ../../documentation/hosting-tools/publish-documentation-online.md:21 msgid "" "You can customize the documentation build using a **.readthedocs.yaml** " "file in your GitHub repository." msgstr "" +"Puedes personalizar la construcción de la documentación usando un " +"archivo **.readthedocs.yaml** en tu repositorio de GitHub." #: ../../documentation/hosting-tools/publish-documentation-online.md:24 msgid "What is GitHub Pages?" -msgstr "" +msgstr "¿Qué es GitHub Pages?" #: ../../documentation/hosting-tools/publish-documentation-online.md:25 msgid "" @@ -201,10 +257,15 @@ msgid "" "using a Continuous Integration setup, and then push to a branch in your " "GitHub repository that is setup to run the GitHub Pages web build." msgstr "" +"[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-" +"github-pages/about-github-pages) es un servicio web gratuito " +"de GitHub. Con GitHub Pages, puedes construir tu documentación localmente " +"o utilizando Continuous Integration, y empujar a una rama de tu repositorio " +"de GitHub que esté configurada para construir la web en GitHub Pages." #: ../../documentation/hosting-tools/publish-documentation-online.md:33 msgid "Read the Docs vs GitHub Pages" -msgstr "" +msgstr "Read the Docs vs GitHub Pages" #: ../../documentation/hosting-tools/publish-documentation-online.md:35 msgid "" @@ -212,6 +273,9 @@ msgid "" "However, you will need to do a bit more work to build and deploy your " "documentation if you use GitHub pages." msgstr "" +"GitHub Pages es una opción buena para el despliegue de tu documentación. " +"Sin embargo, necesitarás hacer un poco más de trabajo para construir y " +"desplegar tu documentación si utilizas GitHub Pages." #: ../../documentation/hosting-tools/publish-documentation-online.md:39 msgid "" @@ -219,16 +283,20 @@ msgid "" "service automates the entire process of building and deploying your " "documentation." msgstr "" - +"Read the Docs se puede configurar a través de tu cuenta de Read the Docs. " +"El servicio automatiza el proceso de construcción y despliegue de tu " +"documentación." #: ../../documentation/hosting-tools/publish-documentation-online.md:42 msgid "" "If you don't want to maintain a documentation website for your Python " "package, we suggest using the Read the Docs website." msgstr "" +"Si no deseas mantener un sitio web de documentación para tu paquete de " +"Python, sugerimos utilizar Read the Docs." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:1 msgid "Using Sphinx to Build Python Package Documentation" -msgstr "" +msgstr "Usando Sphinx para construir documentación de paquetes de Python" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:17 msgid "" @@ -239,10 +307,15 @@ msgid "" "[mkdocs](https://www.mkdocs.org/) which is gaining popularity in the " "Python packaging ecosystem." msgstr "" - +"En esta página presentamos como utilizar [Sphinx](https://www.sphinx-doc.org/) " +"para construir la documentación orientada a los usuarios de tu paquete. Aunque " +"Sphinx es la herramienta más común en la ecosistema de Python científico, " +"puedes explorar otras herramientas para construir documentación como " +"[mkdocs](https://www.mkdocs.org/) que está ganando popularidad en el " +"ecosistema de empaquetado de Python." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:25 msgid "Examples of documentation websites that we love:" -msgstr "" +msgstr "Ejemplos de sitios del web de documentación que nos gustan:" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:27 msgid "[GeoPandas](https://geopandas.org/en/stable/)" @@ -253,6 +326,8 @@ msgid "" "[View rst to create landing " "page](https://raw.githubusercontent.com/geopandas/geopandas/main/doc/source/index.rst)" msgstr "" +"[Ver rst para crear pagina de " +"entrada](https://raw.githubusercontent.com/geopandas/geopandas/main/doc/source/index.rst)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:29 msgid "[verde](https://www.fatiando.org/verde/latest/)" @@ -263,17 +338,21 @@ msgid "" "[View verde landing page code - rst " "file.](https://github.com/fatiando/verde/blob/main/doc/index.rst)" msgstr "" - +"[Ver página de inicio para verde - archivo rst " +".](https://github.com/fatiando/verde/blob/main/doc/index.rst)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:31 msgid "" "[Here is our documentation if you want to see a myST example of a landing" " page.](https://github.com/pyOpenSci/python-package-" "guide/blob/main/index.md)" msgstr "" +"[Aquí está nuestra documentación si deseas leer un ejemplo de página de " +"inicio en myST.](https://github.com/pyOpenSci/python-package-" +"guide/blob/main/index.md)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:34 msgid "Sphinx - a static site generator" -msgstr "" +msgstr "Sphinx - un generador de sitios estáticos" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:36 msgid "" @@ -284,26 +363,36 @@ msgid "" "\"Statically\" which means that there is no generation or modification of" " the files on the fly." msgstr "" +"Sphinx es un [generador de " +"sitios estáticos](https://www.cloudflare.com/es-es/learning/performance/static-site-" +"generator/). Un generador de sitios estáticos es una herramienta que crea " +"HTML para un sitio web basado en plantillas. Los archivos HTML " +"se sirven \"estáticamente\", lo que significa que no hay generación ni modificación " +"de los archivos en línea." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:39 msgid "Sphinx is written using Python." -msgstr "" +msgstr "Sphinx está desarrollado en Python." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:41 msgid "Sphinx sites can be customized using extensions and themes" -msgstr "" +msgstr "La documentación creada con Sphinx puede ser personalizada con extensiones y temas" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:43 msgid "" "The functionality of Sphinx can be extended using extensions and themes. " "A few examples include:" msgstr "" +"La funcionalidad de Sphinx puede ser extendida con extensiones y temas. " +"Algunos ejemplos incluyen:" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:46 msgid "" "You can apply documentation themes for quick generation of beautiful " "documentation." msgstr "" +"Puedes usar temas de documentación para generación rápida de documentación" +"hermosa." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:47 msgid "" @@ -312,6 +401,10 @@ msgid "" "autodoc extension](https://www.sphinx-" "doc.org/en/master/usage/extensions/autodoc.html)" msgstr "" +"Puedes [generar automáticamente documentación para las funciones y clases " +"(la API del paquete) desde los docstrings de tu código usando la extensión " +"autodoc](https://www.sphinx-" +"doc.org/en/master/usage/extensions/autodoc.html)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:48 msgid "" @@ -319,17 +412,23 @@ msgid "" "extension](https://www.sphinx-" "doc.org/en/master/usage/extensions/doctest.html)" msgstr "" +"Puedes [ejecutar y probar ejemplos del código en los docstrings usando la " +"extensión doctest](https://www.sphinx-" +"doc.org/en/master/usage/extensions/doctest.html)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:49 msgid "" -"While Sphinx natively supports the `rST` syntax. You can add custom " +"While Sphinx natively supports the `rST` syntax, you can add custom " "syntax parsers to support easier-to-write syntax using tools such as [the" " MyST parser](https://myst-parser.readthedocs.io/)." msgstr "" +"Aunque Sphinx se basa en sintaxis `rST` de forma nativa, puedes añadir intérpretes de " +"sintaxis personalizadas para usar otras sintaxis más fáciles con herramientas como " +"[MyST](https://myst-parser.readthedocs.io/)." #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:51 msgid "Commonly used Sphinx themes" -msgstr "" +msgstr "Temas comúnes en Sphinx" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:53 msgid "" @@ -337,6 +436,8 @@ msgid "" "most common Sphinx themes used in the Python scientific community " "include:" msgstr "" +"Puedes usar cualquiera tema de Sphinx que prefieras. Sin embargo, los " +"temas más comúnes utilizados en la comunidad de Python científico incluyen:" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:57 msgid "[pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/)" @@ -352,7 +453,7 @@ msgstr "" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:63 msgid "This book is created using Sphinx and the `furo` theme." -msgstr "" +msgstr "Este archivo se crea con Sphinx y el tema `furo`." #: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:1 msgid "Optimizing your documentation so search engines (and other users) find it"