{ "info": { "author": "Ondrej Tuma", "author_email": "mcbig@zeropage.cz", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: Czech", "Natural Language :: English", "Operating System :: POSIX", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Text Processing :: Markup", "Topic :: Utilities" ], "description": "What is Jinja24Doc\n------------------\nJinja24Doc is lightweight documentation generator for python modules with\njinja2 templates. It is part of **Poor Http** group tools (WSGI connector,\nWSGI/HTTP Server and mod_python connector). It could load modules and gets\ndocumentation for its items. No configuration is needed, only jinja2\ntemplates. Your or from jinja2doc package.\n\nIt is more **powerful pydoc**, with style what you want. You can format\nyour documentation string with some simple chars by wiki formating, which\nis similar to *AsciiDoc*. Or you can use standard reStructuredText format. Both\nof these markups parsers support **highlighting** and creating automatic links\nto **PEP**.\n\nDocumentation in few seconds\n----------------------------\nThere are three tools for your usage:\n`rst24doc `_,\n`wiki24doc `_ and\n`jinja24doc `_.\nYou can generate simple page like this with tools rst24doc and wiki24doc in\none command:\n\n.. code-block:: bash\n\n # if your module use reStructuredText formating in documentation strings\n ~$ rst24doc -O your_module.html --embed-stylesheet your_module.py\n # or if your module use wiki formating in documentation strings\n ~$ rst24doc -O your_module.html --embed-stylesheet your_module.py\n\nOr you can create your own template, which import predefined templates from\nJinja24doc. Your ``template.html`` could see like this:\n\n.. code-block:: jinja\n\n {% set title = 'Your Module' %}\n {% set api = load_module('your_module') %}\n {% include '_reference.html' %}\n\nThan call the jinja24doc tool with right parameters from path where your\npython module is available:\n\n.. code-block:: bash\n\n ~$ jinja24doc --embed-stylesheet template.html > your_module.html\n\nJinja24doc as library\n---------------------\nThere are three submodules which you could interest to:\n\n* `apidoc `_ which\n contains base ApiDoc class to read python modules and create list of module\n items by method load_module.\n* `rst `_ which contains\n Rst class based on ApiDoc to parse reStructuredText __doc__ or document.\n* `wiki `_ which contains\n Wiki class based on ApiDoc to parse wiki formated __doc__ or document.\n* `context `_ which\n contains Context class based on Rst and Wiki to couple all functionality\n to working with jinja2 templates.\n* `frontend `_ which\n contains some functions to easier create command tool like rst24doc, wiki24doc\n and jinja24doc.\n\nGetting Jinja24doc\n~~~~~~~~~~~~~~~~~~\nJinja24Doc needs Jinja2, docutils and distutils-tinyhtmlwriter package for\nbuild and or for install. So you must install it first.\n\nSource tarball\n\n.. code-block:: sh\n\n ~$ wget https://pypi.python.org/packages/source/j/jinja24doc/jinja24doc-1.3.3.tar.gz\n ~$ tar xzf jinja24doc-1.3.3.tar.gz\n ~$ cd jinja24doc-1.3.3\n ~$ python setup.py install\n\nSource from git\n~~~~~~~~~~~~~~~\n.. code-block:: sh\n\n ~$ git clone https://github.com/PoorHttp/Jinja24Doc.git\n ~$ cd Jinja24Doc\n ~$ python setup.py install\n\nInstall from PyPI\n~~~~~~~~~~~~~~~~~\n\n.. code-block:: sh\n\n ~$ pip install jinja24doc\n\nUnstable version\n~~~~~~~~~~~~~~~~\nFrom git unstable branch:\n\n.. code-block:: sh\n\n ~$ git clone clone https://github.com/PoorHttp/Jinja24Doc.git\n ~$ cd Jinja24Doc\n ~$ git checkout unstable\n ~$ python setup.py install\n\nor from zip package:\n\n.. code-block:: sh\n\n ~$ wget https://github.com/PoorHttp/Jinja24Doc/archive/unstable.zip\n ~$ unzip unstable.zip\n ~$ cd Jinja24Doc-unstable\n ~$ python setup.py install\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://poorhttp.zeropage.cz/jinja24doc", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "jinja24doc", "package_url": "https://pypi.org/project/jinja24doc/", "platform": "", "project_url": "https://pypi.org/project/jinja24doc/", "project_urls": { "Homepage": "http://poorhttp.zeropage.cz/jinja24doc" }, "release_url": "https://pypi.org/project/jinja24doc/1.3.3/", "requires_dist": [ "docutils-tinyhtmlwriter", "jinja2 (>=2.10)" ], "requires_python": "", "summary": "Jinja24Doc for Python", "version": "1.3.3" }, "last_serial": 5598241, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "3e273677f7f1a6110f555389fd8c1caa", "sha256": "9c6d3c21db6c49e48607d5b1cd7c289bca8adcd46f83d7c44e4bb936d88d2814" }, "downloads": -1, "filename": "jinja24doc-1.0.tar.gz", "has_sig": false, "md5_digest": "3e273677f7f1a6110f555389fd8c1caa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14427, "upload_time": "2014-01-25T23:46:41", "url": "https://files.pythonhosted.org/packages/de/5d/03253115027f0fdd4f6460b464cbd1fff9ec049bf499f04b4807d261d328/jinja24doc-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "c143d772015d25e9bab9d0fd19fb10a0", "sha256": "d54442f93f269be74625581da83f81212a55630ad84bdc1eec5f8176fb51e7f0" }, "downloads": -1, "filename": "jinja24doc-1.0.1.tar.gz", "has_sig": true, "md5_digest": "c143d772015d25e9bab9d0fd19fb10a0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15032, "upload_time": "2014-01-30T16:03:34", "url": "https://files.pythonhosted.org/packages/7d/d1/640a1051ac4f43eace7b710a97296d1d694fbbecaaa29d4e10cb1645b2e7/jinja24doc-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "541b656d94a1fd7a4a995ab490c9330a", "sha256": "eaf4ac98529376c2f7d71d42b6c2d37cf830f162ff801cd987e0aed8a7d8c2de" }, "downloads": -1, "filename": "jinja24doc-1.1.0.tar.gz", "has_sig": true, "md5_digest": "541b656d94a1fd7a4a995ab490c9330a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19712, "upload_time": "2014-04-29T20:25:43", "url": "https://files.pythonhosted.org/packages/51/9c/a5696dd6af9ac68fb85aa64b96c3208fbd5f393c54c8f62b156380e61c6f/jinja24doc-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "7d3ab8147890589555a1965b422ab3a6", "sha256": "364a93d8a555effad8a60345fa7f5781aa73f4aad80b5b505130d20b846d668e" }, "downloads": -1, "filename": "jinja24doc-1.2.0.tar.gz", "has_sig": true, "md5_digest": "7d3ab8147890589555a1965b422ab3a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18787, "upload_time": "2014-08-22T20:24:27", "url": "https://files.pythonhosted.org/packages/b6/5f/aed370118de103b90180b179c6f4cda96f51666de35a60857bfee057b384/jinja24doc-1.2.0.tar.gz" } ], "1.3.1": [ { "comment_text": "", "digests": { "md5": "058364109c97be8849a46b4e2b91ed9d", "sha256": "c7047bae809a5adbddc0b9d86c222b34a50707d111caa6993db60db0bfb1750a" }, "downloads": -1, "filename": "jinja24doc-1.3.1.tar.gz", "has_sig": true, "md5_digest": "058364109c97be8849a46b4e2b91ed9d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24554, "upload_time": "2016-04-13T05:34:04", "url": "https://files.pythonhosted.org/packages/b7/ae/c6278e7e533b2ecf1ccadd497408f93d17ecd98f9067ad90a3c51ed70f86/jinja24doc-1.3.1.tar.gz" } ], "1.3.2": [ { "comment_text": "", "digests": { "md5": "4cc47e06fabf9b7766b09006b1cd03f8", "sha256": "1c6545df292ae713517dfb5c6cc561b6c0d950c4b934b403846d93209fca1cb1" }, "downloads": -1, "filename": "jinja24doc-1.3.2-py2-none-any.whl", "has_sig": false, "md5_digest": "4cc47e06fabf9b7766b09006b1cd03f8", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 75493, "upload_time": "2018-11-08T06:37:28", "url": "https://files.pythonhosted.org/packages/4c/36/ed061637f876add22b9429baced3df9538e0758128181e58677bb5fb0846/jinja24doc-1.3.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cac924d7350e52197b1528bc48a8757f", "sha256": "d3a073bd236c738280b99f37d45f4a4ee3372e8c99d35fca5ccbb12b10c88c0d" }, "downloads": -1, "filename": "jinja24doc-1.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "cac924d7350e52197b1528bc48a8757f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 52217, "upload_time": "2018-11-08T06:37:30", "url": "https://files.pythonhosted.org/packages/a5/54/992146555f479d80cd0fe2158ae441770264d5919117d0e07e4c2604453d/jinja24doc-1.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1c48bcfb4cacdeeddd66089e75337905", "sha256": "c11817c3f747f7bd90a0608a88769fff6bdc2417161d13bdca5e8a648d9bc5a8" }, "downloads": -1, "filename": "jinja24doc-1.3.2.tar.gz", "has_sig": true, "md5_digest": "1c48bcfb4cacdeeddd66089e75337905", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29661, "upload_time": "2018-11-08T06:37:32", "url": "https://files.pythonhosted.org/packages/23/c5/323aa3597197e3c9d39e321cf8d4e162b7b0cb9d1f01aa7d3b2b4fa862e4/jinja24doc-1.3.2.tar.gz" } ], "1.3.3": [ { "comment_text": "", "digests": { "md5": "d86a3576ccfd0bcc55c99515648a0eb8", "sha256": "a2beee1c1feb6d2d5baf5dc4511ccc3f1ef9dd49d9ac48c610134f1b0677f4dd" }, "downloads": -1, "filename": "jinja24doc-1.3.3-py2-none-any.whl", "has_sig": false, "md5_digest": "d86a3576ccfd0bcc55c99515648a0eb8", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 72935, "upload_time": "2019-07-29T08:22:12", "url": "https://files.pythonhosted.org/packages/b8/33/95a50637fb3b36cd636375032f11a10b5a173be71f4b872013089b67c0c5/jinja24doc-1.3.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e6471f4698fd398baeaa4cac1707b851", "sha256": "7dc7eb8d95b1597d474da0426dc65c1dfb9426eaae81548b0dcf7c597f34731b" }, "downloads": -1, "filename": "jinja24doc-1.3.3-py3-none-any.whl", "has_sig": false, "md5_digest": "e6471f4698fd398baeaa4cac1707b851", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 73964, "upload_time": "2019-07-29T08:22:14", "url": "https://files.pythonhosted.org/packages/54/d4/04274fce4dee9adb97b609342039b7203a14056504a50b87ce122d208409/jinja24doc-1.3.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "802f57012f9e974426c9b8cc05ab24e8", "sha256": "7e1f6ca0b57c9cc72434bd15d6dcb645b2bdd6ed75b4ac7a64a5fedf1deabef7" }, "downloads": -1, "filename": "jinja24doc-1.3.3.tar.gz", "has_sig": false, "md5_digest": "802f57012f9e974426c9b8cc05ab24e8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30448, "upload_time": "2019-07-29T08:22:16", "url": "https://files.pythonhosted.org/packages/8e/a0/17591751bfe60abe372ce8a16e11e5aad6615e13045c2dd63dc324012769/jinja24doc-1.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d86a3576ccfd0bcc55c99515648a0eb8", "sha256": "a2beee1c1feb6d2d5baf5dc4511ccc3f1ef9dd49d9ac48c610134f1b0677f4dd" }, "downloads": -1, "filename": "jinja24doc-1.3.3-py2-none-any.whl", "has_sig": false, "md5_digest": "d86a3576ccfd0bcc55c99515648a0eb8", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 72935, "upload_time": "2019-07-29T08:22:12", "url": "https://files.pythonhosted.org/packages/b8/33/95a50637fb3b36cd636375032f11a10b5a173be71f4b872013089b67c0c5/jinja24doc-1.3.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e6471f4698fd398baeaa4cac1707b851", "sha256": "7dc7eb8d95b1597d474da0426dc65c1dfb9426eaae81548b0dcf7c597f34731b" }, "downloads": -1, "filename": "jinja24doc-1.3.3-py3-none-any.whl", "has_sig": false, "md5_digest": "e6471f4698fd398baeaa4cac1707b851", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 73964, "upload_time": "2019-07-29T08:22:14", "url": "https://files.pythonhosted.org/packages/54/d4/04274fce4dee9adb97b609342039b7203a14056504a50b87ce122d208409/jinja24doc-1.3.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "802f57012f9e974426c9b8cc05ab24e8", "sha256": "7e1f6ca0b57c9cc72434bd15d6dcb645b2bdd6ed75b4ac7a64a5fedf1deabef7" }, "downloads": -1, "filename": "jinja24doc-1.3.3.tar.gz", "has_sig": false, "md5_digest": "802f57012f9e974426c9b8cc05ab24e8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30448, "upload_time": "2019-07-29T08:22:16", "url": "https://files.pythonhosted.org/packages/8e/a0/17591751bfe60abe372ce8a16e11e5aad6615e13045c2dd63dc324012769/jinja24doc-1.3.3.tar.gz" } ] }