generators

Nota

Módulo encargado de la generación de los ficheros necesarios de Sphinx.

makefiles

generators.makefiles.gen_window_makefile(file_path)

Genera windows make.bat

Parámetros

file_path (str) – ruta para guardar el fichero

generators.makefiles.gen_makefile(file_path)

Genera el makefile

Parámetros

file_path (str) – ruta para guardar el fichero

rst_file

generators.rst_file.generate_index_rst(file_path, project_name, readme_file_path, python_files, python_packages)

Genera el fichero index.rst, el fichero raíz de la documentación

Parámetros

  • file_path (str) – ruta para guardar el fichero

  • project_name (str) – nombre del proyecto

  • readme_file_path (str) – ruta del fichero README.md

  • python_files (list) – lista de los ficheros .py que deben estar en el fichero

  • python_packages (list) – lista de los módulos que deben estar en el fichero

generators.rst_file.generate_markdown_rst(file_path, name, md_file_path)

Genera un fichero .rst a raíz de uno .md usando la directiva "..mdinclude::" del paquete m2r

Parámetros

  • file_path (str) – ruta para guardar el fichero

  • name (str) – nombre del fichero markdown

  • md_file_path (str) – ruta del fichero markdown

generators.rst_file.generate_package_leaf_rst(file_path, package_name, python_files, init)

Genera el fichero .rst de un paquete python que no contiene ningún submódulo

Parámetros

  • file_path (str) – ruta del fichero para guardar

  • package_name (str) – nombre del módulo

  • python_files (list) – lista con los fichero `.py del módulo

  • init (str) – ruta del fichero __init__.py

generators.rst_file.generate_package_not_leaf_rst(file_path, package_name, python_files, python_packages, init)

Genera el fichero .rst de un paquete python que contiene algún submódulo

Parámetros

  • file_path (str) – ruta del fichero para guardar

  • package_name (str) – nombre del módulo

  • python_files (list) – lista con los fichero `.py del módulo

  • python_packages (list) – lista con los submódulos del módulo python

  • init (str) – ruta del fichero __init__.py

sphinx_config_file

generators.sphinx_config_file.generate_config_file(root_folder, project_name, author, version, language_locale, file_path, html_options=None, latex_options=None, mocks_imports=None, extra_extensions=None)

Genera el fichero de configuración necesario para sphinx

Parámetros

  • root_folder (str) – ruta de la carpeta raíz del proyecto a documentar

  • project_name (str) – nombre del proyecto

  • author (str) – autor

  • version (str) – versión del proyecto

  • language_locale (str) – código lingüístico del país

  • file_path (str) – ruta del fichero para guardar

  • html_options (dict) – diccionario con las opciones de configuración html para Sphinx

  • latex_options (dict) – diccionario con las opciones de configuración LaTeX para Sphinx

  • mocks_imports (list) – lista de las importaciones que deben ignorarse dentro del ficheros

  • extra_extensions (list) – lista con las extensiónes extra de Sphinx

generators.sphinx_config_file.generate_html_config(html_options=None)

Genera la información necesaria para la compilación a HTML

Parámetros

html_options (dict) – diccionario con las opciones html de Sphinx

Devuelve

string con la información necesaría para añadir al fichero `conf.py en lo referente a las opciones html

Tipo del valor devuelto

str

generators.sphinx_config_file.generate_latex_config(latex_options=None)

Genera la información necesaria para la compilación a LaTeX

Parámetros

latex_options (dict) – diccionario con las opciones LaTeX de Sphinx

Devuelve

string con la información necesaría para añadir al fichero `conf.py en lo referente a las opciones LaTeX

Tipo del valor devuelto

str

sphinx_structure

generators.sphinx_structure.generate_structure(root_folder, project_name, author, version, language_locale, readme_file, license_file, changelog_file, excludes=None, ignores=None, html_options=None, latex_options=None, mocks_imports=None, sphinx_extensions=None)

Genera la estructura de Sphinx de acuerdo a los parámetros recibidos.

Parámetros

  • root_folder (str) – ruta de la carpeta raíz del proyecto a documentar

  • project_name (str) – nombre del proyecto

  • author (str) – autor

  • version (str) – versión

  • language_locale (str) – código lingüístico del país

  • readme_file (str) – ruta del fichero README.md

  • license_file (str) – ruta del fichero LICENSE.md

  • changelog_file (str) – ruta del fichero CHANGELOG.md

  • excludes (list) – lista con los elementos a excluir

  • ignores (list) – lista con los elementos a ignorar

  • html_options (dict) – diccionario con la configuración html de Sphinx

  • latex_options (dict) – diccionario con la configuración LaTeX de Sphinx

  • mocks_imports (list) – lista con las importaciones que deben ignorarse dentro del proyecto

generators.sphinx_structure.generate_modules_srt(root_module)

Genera los ficheros .rst de los módulos identificados

Parámetros

root_module (Module) – módulo raíz del proyecto a documentar