Metadata-Version: 2.1
Name: pyautodoc
Version: 0.6.3
Summary: UNKNOWN
Home-page: https://github.com/alvarogf97/pyautodoc
Author: Alvaro
Author-email: alvarogf97@gmail.com
License: MIT
Description: Pyautodoc permite la creaciÃ³n de documentaciÃ³n de los proyectos python de forma totalmente automÃ¡tica y
        configurable. Hace uso del proyecto [Sphinx](http://www.sphinx-doc.org/en/master/) y de extensiones como 
        [autodoc](http://www.sphinx-doc.org/es/stable/ext/autodoc.html) para generar la documentaciÃ³n en funciÃ³n
        de los **docstring** de las clases y mÃ©todos del proyecto. Puedes leer la documentaciÃ³n generada con este proyecto,
        y sobre este proyecto [pinchando aqui](https://alvarogf97.github.io/pyautodoc/index.html)
        
        # GuÃ­a rÃ¡pida
        
        ## InstalaciÃ³n:
        
        Desde **github** podemos instalarlo ejecutando:
        ````
        pip install git+https://github.com/alvarogf97/pyautodoc.git
        ````
        
        Desde **PyPi**:
        
        ````
        PrÃ³ximamente
        ````
        
        ## Uso
        
        **NOTA**:
        para compilar a latex es necesario tener instalado compilador para el mismo. En windows se necesita 
        **MiKTeX** y **Perl**
        
        ### Desde consola:
        
        Ejecutamos el comando:
        
        ````
        pyautodoc
        ````
        
        Indicamos 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 carpeta **output/source** se encontrarÃ¡n los ficheros generados. Para compilar a html o pdf ejecutamos:
        ````
        make html
        make latexpdf
        ````
        desde la carpeta **output**
        
        ### Desde yaml:
        
        Podemos crear un fichero ```pydoc.yaml``` con 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 documento ```pydoc.yaml``` es: 
        
        ````yaml
        ####################################################
        #                   GENERAL CONFIG                 #
        ####################################################
        project_name: PyAutoDoc
        author: Alvaro
        version: 0.5
        language_locale: es
        root_folder: pyautodoc
        output_folder: MyOutputFolder
        sphinx_extensions:
          - sphinx.ext.viewcode
        
        ####################################################
        #                     EXTRA FILES                  #
        ####################################################
        readme_file: README.md
        license_file: LICENSE.md
        changelog_file: CHANGELOG.md
        
        ####################################################
        #                   PROJECT CONFIG                 #
        ####################################################
        # paquetes o ficheros especÃ­ficos que no estarÃ¡n en 
        # la documentaciÃ³n
        excludes:
          - scripts
        
        # paquetes o ficheros generales que no estarÃ¡n en 
        # la documentaciÃ³n ej: todos los ficheros test.py
        ignores:
          - 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_2
          template_options:
            logo: MyLogo
            github_user: alvarogf97
            github_repo: pyautodoc
            fixed_sidebar: True
            description: Pyautodoc! Automatize your python project documentation
        
        ####################################################
        #                 LaTeX PDF CONFIG                 #
        ####################################################
        latex_config:
          latex_engine: pdflatex
          latex_logo: MyLogo
        ````
        
        Para generar la documentaciÃ³n ejecutamos:
        ````
        pyautodoc --yaml
        ````
        
        Alternativamente, si el fichero ``.yaml`` tiene otro nombre, o esta en otra localizaciÃ³n, podemos
        ejecutar:
        
        ````
        pyautodoc --yaml <Ruta del fichero .yaml>
        ````
        
        ## Subir documentaciÃ³n a github
         - AÃ±adimos ``sphinx.ext.githubpages`` a las ``sphinx_extensions`` 
         - Creamos una directorio **docs** en el directorio raÃ­z del repositorio
         - Copiamos el contenido del directorio ``/build/html`` al directorio ``docs``
         - Copiamos el directorio ``source`` al directorio ``docs``
         - Hacemos ``comit`` y ``push``
         - En github nos vamos a **settings > github pages > source** y seleccionamos **master branch/docs folder** 
Platform: UNKNOWN
Requires-Python: >=3.4
Description-Content-Type: text/markdown
