La documentación correspondiente al paquete turbulence.py se ha desarrollado en el lenguaje markdown dado que posee una fácil exportación a formatos HTML y PDF, además de que el texto puede ser leído por cualquier editor de texto plano (Desde text editor hasta VisualStudio Code); así que con el ánimo de aportar a la fácil documentación a continuación se dan algunas indicaciones y recomendaciones.
Como se mencionó, cualquier editor de texto plano es funcional pero para sacar mayor partido de este lenguaje se recomienda usar typodora. Para instalarlo en su equipo linux solo tiene que ejecutar las siguientes líneas:
# or run:# sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys BA300B7755AFCFAEwget -qO - https://typora.io/linux/public-key.asc | sudo apt-key add -# add Typora's repositorysudo add-apt-repository 'deb https://typora.io/linux ./'sudo apt-get update# install typorasudo apt-get install typoraHecho esto ya puede comenzar a editar la documentación fácilmente, además de poder exportarla a HTML(entre muchos otros formatos) siguiendo las siguientes instrucciones:
xxxxxxxxxxFile --> Export --> HTML
Typodora puede exportar archivos directamente a formato PDF; sin embargo, una de las ventajas de emplear lenguaje markdown, es que puede ser compatible con sentencias en lenguaje LaTeX. Si bien, desde typodora se pueden exportar a PDF siguiendo las instrucciones File --> Export --> PDF, resulta conveniente emplear la librería Pandoc. Para ello se debe asegurar que se cuenta con lenguaje LaTeX en el equipo linux, lo cual puede verificar a traves de la siguiente sentencia en terminal:
xxxxxxxxxxlatex --versionEsto debería retorna algo similar a:
xxxxxxxxxx pdfTeX 3.14159265-2.6-1.40.20 (TeX Live 2019/Debian) kpathsea version 6.3.1 Copyright 2019 Han The Thanh (pdfTeX) et al. There is NO warranty. Redistribution of this software is covered by the terms of both the pdfTeX copyright and the Lesser GNU General Public License. For more information about these matters, see the file named COPYING and the pdfTeX source. Primary author of pdfTeX: Han The Thanh (pdfTeX) et al. Compiled with libpng 1.6.37; using libpng 1.6.37 Compiled with zlib 1.2.11; using zlib 1.2.11 Compiled with xpdf version 4.01En caso de no tener ninguna versión en su sistema operativo se presentan dos opciones para instalarlo:
Una vez se tenga LaTeX en el equipo, la instalación y verificación de pandoc se hace con las siguientes líneas en la terminal:
xxxxxxxxxxsudo apt install pandocpandoc --versionDebería de obtener algo similar a:
xxxxxxxxxx pandoc 2.11 Compiled with pandoc-types 1.22, texmath 0.12.0.3, skylighting 0.10.0.2 Default user data directory: /home/jmmontoyaz/.local/share/pandoc or /home/jmmontoyaz/.pandoc Copyright (C) 2006-2020 John MacFarlane Web: https://pandoc.org This is free software; see the source for copying conditions. There is no warranty, not even for merchantability or fitness for a particular purpose.Con pandoc funcionando en el equipo ya se puede pegar código LaTeX directamente en el archivo markdown y exportar a pdf. Aquí se muestra un ejemplo de cómo hacerlo empleando la siguiente sentencia en terminal2.
xxxxxxxxxxpandoc --from=markdown --output=my.pdf my.md \ --variable=geometry:"margin=0.5cm, paperheight=421pt, paperwidth=595pt" \ --highlight-style=espressoDe los principales problema que tiene trabajar con markdown es que hasta donde se sabe no existe un editor compartido online(parecido a lo que sí se puede hacer con overleaf) por lo que se propone que para la edición de la documentación se cumpla el siguiente flujo de trabajo: