{ "info": { "author": "Alvaro", "author_email": "alvarogf97@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "Pyautodoc permite la creaci\u00c3\u00b3n de documentaci\u00c3\u00b3n de los proyectos python de forma totalmente autom\u00c3\u00a1tica y\nconfigurable. Hace uso del proyecto [Sphinx](http://www.sphinx-doc.org/en/master/) y de extensiones como \n[autodoc](http://www.sphinx-doc.org/es/stable/ext/autodoc.html) para generar la documentaci\u00c3\u00b3n en funci\u00c3\u00b3n\nde los **docstring** de las clases y m\u00c3\u00a9todos del proyecto. Puedes leer la documentaci\u00c3\u00b3n generada con este proyecto,\ny sobre este proyecto [pinchando aqui](https://alvarogf97.github.io/pyautodoc/index.html)\n\n# Gu\u00c3\u00ada r\u00c3\u00a1pida\n\n## Instalaci\u00c3\u00b3n:\n\nDesde **github** podemos instalarlo ejecutando:\n````\npip install git+https://github.com/alvarogf97/pyautodoc.git\n````\n\nDesde **PyPi**:\n\n````\npip install pyautodoc\n````\n\n## Uso\n\n**NOTA**:\npara compilar a latex es necesario tener instalado compilador para el mismo. En windows se necesita \n**MiKTeX** y **Perl**\n\n### Desde consola:\n\nEjecutamos el comando:\n\n````\npyautodoc\n````\n\nIndicamos los datos necesarios:\n\n````\nEnter project name: \nEnter author: \nEnter current version: \nEnter language locale (leave blank for es): \nEnter path for root project folder: \nEnter path for README.md (leave blank if you don't want to include it): \nEnter path for LICENSE.md (leave blank if you don't want to include it): \nEnter path for CHANGELOG.md (leave blank if you don't want to include it): \nEnter path for Output folder: \n````\n\nEn la carpeta **output/source** se encontrar\u00c3\u00a1n los ficheros generados. Para compilar a html o pdf ejecutamos:\n````\nmake html\nmake latexpdf\n````\ndesde la carpeta **output**\n\n### Desde yaml:\n\nPodemos crear un fichero ```pydoc.yaml``` con la configuraci\u00c3\u00b3n necesaria para la generaci\u00c3\u00b3n autom\u00c3\u00a1tica de la\ndocumentaci\u00c3\u00b3n, esta opci\u00c3\u00b3n permite una configuraci\u00c3\u00b3n mucho mas amplia que la generaci\u00c3\u00b3n por consola.\n\nLa estructura del documento ```pydoc.yaml``` es: \n\n````yaml\n####################################################\n# GENERAL CONFIG #\n####################################################\nproject_name: PyAutoDoc\nauthor: Alvaro\nversion: 0.5\nlanguage_locale: es\nroot_folder: pyautodoc\noutput_folder: MyOutputFolder\nsphinx_extensions:\n - sphinx.ext.viewcode\n\n####################################################\n# EXTRA FILES #\n####################################################\nreadme_file: README.md\nlicense_file: LICENSE.md\nchangelog_file: CHANGELOG.md\n\n####################################################\n# PROJECT CONFIG #\n####################################################\n# paquetes o ficheros espec\u00c3\u00adficos que no estar\u00c3\u00a1n en \n# la documentaci\u00c3\u00b3n\nexcludes:\n - scripts\n\n# paquetes o ficheros generales que no estar\u00c3\u00a1n en \n# la documentaci\u00c3\u00b3n ej: todos los ficheros test.py\nignores:\n - test.py\n\n# paquetes que no se deben importar al leer los \n# ficheros (solo se necesita especificar el paquete\n# de mas alto nivel)\nmocks_imports:\n - django\n - pyautodoc\n\n####################################################\n# COMPILING CONFIG #\n####################################################\nmakes:\n - html\n #- pdf\n\n####################################################\n# HTML CONFIG #\n####################################################\nhtml_config:\n template_theme: alabaster\n #custom_css:\n #template_package: sphinx_theme\n #template_path: sphinx_theme.get_html_theme_path('stanford-theme')\n #template_extensions:\n # - ext_1\n # - ext_2\n template_options:\n logo: MyLogo\n github_user: alvarogf97\n github_repo: pyautodoc\n fixed_sidebar: True\n description: Pyautodoc! Automatize your python project documentation\n\n####################################################\n# LaTeX PDF CONFIG #\n####################################################\nlatex_config:\n latex_engine: pdflatex\n latex_logo: MyLogo\n````\n\nPara generar la documentaci\u00c3\u00b3n ejecutamos:\n````\npyautodoc --yaml\n````\n\nAlternativamente, si el fichero ``.yaml`` tiene otro nombre, o esta en otra localizaci\u00c3\u00b3n, podemos\nejecutar:\n\n````\npyautodoc --yaml \n````\n\n## Subir documentaci\u00c3\u00b3n a github\n - A\u00c3\u00b1adimos ``sphinx.ext.githubpages`` a las ``sphinx_extensions`` \n - Creamos una directorio **docs** en el directorio ra\u00c3\u00adz del repositorio\n - Copiamos el contenido del directorio ``/build/html`` al directorio ``docs``\n - Copiamos el directorio ``source`` al directorio ``docs``\n - Hacemos ``comit`` y ``push``\n - En github nos vamos a **settings > github pages > source** y seleccionamos **master branch/docs folder**", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/alvarogf97/pyautodoc", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pyautodoc", "package_url": "https://pypi.org/project/pyautodoc/", "platform": "", "project_url": "https://pypi.org/project/pyautodoc/", "project_urls": { "Homepage": "https://github.com/alvarogf97/pyautodoc" }, "release_url": "https://pypi.org/project/pyautodoc/0.7/", "requires_dist": null, "requires_python": ">=3.4", "summary": "", "version": "0.7" }, "last_serial": 5437157, "releases": { "0.6.3": [ { "comment_text": "", "digests": { "md5": "7f120bb5a6556b7094a4fd3ce9b79ab1", "sha256": "bab0363bf9f4f8a6098f1c98574133175880c133a010a00a4053cdc2b26b988b" }, "downloads": -1, "filename": "pyautodoc-0.6.3.tar.gz", "has_sig": false, "md5_digest": "7f120bb5a6556b7094a4fd3ce9b79ab1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13790, "upload_time": "2019-06-02T20:34:08", "url": "https://files.pythonhosted.org/packages/b7/ef/af75654f7e07d5ca488a3250b6b65c4f74027a4dd3e57685588fc8e38a84/pyautodoc-0.6.3.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "3573747e0921a11bcd9d51d599034278", "sha256": "1c5d582e5b8042dd8084feabdc75336dd388728fea2d5a5df0991dcdbe7965d1" }, "downloads": -1, "filename": "pyautodoc-0.7.tar.gz", "has_sig": false, "md5_digest": "3573747e0921a11bcd9d51d599034278", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13772, "upload_time": "2019-06-23T12:12:16", "url": "https://files.pythonhosted.org/packages/c5/07/1bf88c57c5f9b8d854c772c5c3377699c23d817a743a9e2a0cdbeffff387/pyautodoc-0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3573747e0921a11bcd9d51d599034278", "sha256": "1c5d582e5b8042dd8084feabdc75336dd388728fea2d5a5df0991dcdbe7965d1" }, "downloads": -1, "filename": "pyautodoc-0.7.tar.gz", "has_sig": false, "md5_digest": "3573747e0921a11bcd9d51d599034278", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13772, "upload_time": "2019-06-23T12:12:16", "url": "https://files.pythonhosted.org/packages/c5/07/1bf88c57c5f9b8d854c772c5c3377699c23d817a743a9e2a0cdbeffff387/pyautodoc-0.7.tar.gz" } ] }