This package has the following functionality:
.yaml
data files and .md
templates to produce readable documentation filesaide_document
pip
installed by running pip -V
in your terminal/command line. pip
comes with Python 2 >=2.7.9 or Python 3 >=3.4, but if you don't have it, follow these instructions.pip install aide_document
.Pandoc is required for converting Markdown files to PDF. More detailed installation instructions can be found here.
brew install pandoc
To convert Markdown to PDF using Pandoc, you must install TeX Live for your operating system. Here are installation files for each OS:
You can make documentation files and convert them between various filetypes:
from aide_document import convert
Within convert
, there are the following self-explanatory functions:
yaml_to_md(input_name, output_name, template_name)
md_to_pdf(input_filename, output_filename)
docx_to_md(input_filename, output_filename)
You can also translate the file on a line by line basis:
from aide_document import translate
Within translate
, there are the following self-explanatory functions:
translate(input_name, source_language, target_language, output_name)
A sample Jekyll website for the outputs: https://aguaclara.github.io/aide_document/index.html
Check our wiki for our presentations.