Package: pyautodoc
Pyautodoc permite la creaciÃ³n de documentaciÃ³n de los proyectos python de forma totalmente automÃ¡tica y
configurable. Hace uso del proyectoSphinxy de extensiones comoautodocpara generar la documentaciÃ³n en funciÃ³n
de losdocstringde las clases y mÃ©todos del proyecto. Puedes leer la documentaciÃ³n generada con este proyecto,
y sobre este proyectopinchando aquiGuÃ­a rÃ¡pidaInstalaciÃ³n:Desdegithubpodemos instalarlo ejecutando:pip install git+https://github.com/alvarogf97/pyautodoc.gitDesdePyPi:pip install pyautodocUsoNOTA:
para compilar a latex es necesario tener instalado compilador para el mismo. En windows se necesitaMiKTeXyPerlDesde consola:Ejecutamos el comando:pyautodocIndicamos los datos necesarios:Enter project name: <Nombre del proyecto>
Enter author: <Autor>
Enter current version: <Version>
Enter language locale (leave blank for es): <CÃ³digo del paÃ­s para las traducciones>
Enter path for root project folder: <carpeta del proyecto a documentar>
Enter path for README.md (leave blank if you don't want to include it): <fichero readme>
Enter path for LICENSE.md (leave blank if you don't want to include it): <fichero license>
Enter path for CHANGELOG.md (leave blank if you don't want to include it): <fichero changelog>
Enter path for Output folder: <Carpeta para generar la documentaciÃ³n>En la carpetaoutput/sourcese encontrarÃ¡n los ficheros generados. Para compilar a html o pdf ejecutamos:make html
make latexpdfdesde la carpetaoutputDesde yaml:Podemos crear un ficheropydoc.yamlcon la configuraciÃ³n necesaria para la generaciÃ³n automÃ¡tica de la
documentaciÃ³n, esta opciÃ³n permite una configuraciÃ³n mucho mas amplia que la generaciÃ³n por consola.La estructura del documentopydoc.yamles:#####################################################                   GENERAL CONFIG                 #####################################################project_name:PyAutoDocauthor:Alvaroversion:0.5language_locale:esroot_folder:pyautodocoutput_folder:MyOutputFoldersphinx_extensions:-sphinx.ext.viewcode#####################################################                     EXTRA FILES                  #####################################################readme_file:README.mdlicense_file:LICENSE.mdchangelog_file:CHANGELOG.md#####################################################                   PROJECT CONFIG                 ###################################################### paquetes o ficheros especÃ­ficos que no estarÃ¡n en# la documentaciÃ³nexcludes:-scripts# paquetes o ficheros generales que no estarÃ¡n en# la documentaciÃ³n ej: todos los ficheros test.pyignores:-test.py# paquetes que no se deben importar al leer los# ficheros (solo se necesita especificar el paquete# de mas alto nivel)mocks_imports:-django-pyautodoc#####################################################                  COMPILING CONFIG                #####################################################makes:-html#- pdf#####################################################                    HTML CONFIG                   #####################################################html_config:template_theme:alabaster#custom_css:#template_package: sphinx_theme#template_path: sphinx_theme.get_html_theme_path('stanford-theme')#template_extensions:# - ext_1# - ext_2template_options:logo:MyLogogithub_user:alvarogf97github_repo:pyautodocfixed_sidebar:Truedescription:Pyautodoc! Automatize your python project documentation#####################################################                 LaTeX PDF CONFIG                 #####################################################latex_config:latex_engine:pdflatexlatex_logo:MyLogoPara generar la documentaciÃ³n ejecutamos:pyautodoc --yamlAlternativamente, si el fichero.yamltiene otro nombre, o esta en otra localizaciÃ³n, podemos
ejecutar:pyautodoc --yaml <Ruta del fichero .yaml>Subir documentaciÃ³n a githubAÃ±adimossphinx.ext.githubpagesa lassphinx_extensionsCreamos una directoriodocsen el directorio raÃ­z del repositorioCopiamos el contenido del directorio/build/htmlal directoriodocsCopiamos el directoriosourceal directoriodocsHacemoscomitypushEn github nos vamos asettings > github pages > sourcey seleccionamosmaster branch/docs folder