{ "info": { "author": "Antony Lee", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: Unix", "Programming Language :: Python :: 3", "Topic :: Documentation" ], "description": "speedoc \u2013 sphinx meets pydoc\n============================\n\nTurn docstrings into man pages using Sphinx_, and view the result with ``man``.\n\n.. _Sphinx: http://www.sphinx-doc.org\n\nInstallation\n------------\n\n.. code:: sh\n\n python -mpip install git+https://github.com/anntzer/speedoc\n\nTests can be run with pytest_.\n\n.. _pytest: https://docs.pytest.org\n\nUsage\n-----\n\n.. code:: sh\n\n speedoc [--opts ...] obj.to.document\n\nOptions are passed as is to ``python -msphinx``. By default, ``sphinx`` is\ninvoked as\n\n.. code:: sh\n\n # $tmpdir1, $tmpdir2 are set up by speedoc.\n # -bman: build a man page; -q: quietly\n python -msphinx $tmpdir1 $tmpdir2 -bman -q -Dextensions=sphinx.ext.napoleon\n\nwith a minimal ``conf.py`` that sets ``man_pages = [(\"contents\", obj_name,\n\"\\n\", \"\", \"3\")]``. To use, e.g., numpydoc_ instead of sphinx.ext.napoleon_,\ncall\n\n.. code:: sh\n\n speedoc -Dextensions=sphinx.ext.autodoc,numpydoc obj.to.document\n\n(With numpydoc\u22650.9, it is not necessary anymore to explicitly load autodoc.)\n\nOptions to ``man`` can be passed by setting the (standard) ``MANOPT``\nenvironment variable. For example, justification can be disabled with\n\n.. code:: sh\n\n MANOPT=--nj speedoc ...\n\n.. _numpydoc: https://numpydoc.readthedocs.io\n.. _sphinx.ext.autosummary: http://www.sphinx-doc.org/ext/autosummary.html\n.. _sphinx.ext.napoleon: http://www.sphinx-doc.org/ext/napoleon.html\n\nTroubleshooting\n---------------\n\n:Q: Docstrings are rendered terribly!\n:A: Invalid RST formatting is very common :-(\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/anntzer/speedoc", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "speedoc", "package_url": "https://pypi.org/project/speedoc/", "platform": "", "project_url": "https://pypi.org/project/speedoc/", "project_urls": { "Homepage": "https://github.com/anntzer/speedoc" }, "release_url": "https://pypi.org/project/speedoc/0.2/", "requires_dist": [ "sphinx (>=1.5)" ], "requires_python": ">=3", "summary": "sphinx meets pydoc.", "version": "0.2" }, "last_serial": 5540839, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "355dcb5ab1100ea4d35e1daa098c0ac4", "sha256": "974eaeccda45d31dfcf66a8e42214a26040600362d4c2e942011f317fb365bf1" }, "downloads": -1, "filename": "speedoc-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "355dcb5ab1100ea4d35e1daa098c0ac4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 4043, "upload_time": "2018-04-07T05:03:27", "url": "https://files.pythonhosted.org/packages/5a/ed/351bc4392b4fa8ba5c4322025bebe293ece40dfd699777f8e79b696de07c/speedoc-0.1-py3-none-any.whl" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "13d2ee19e227cd23b75d047acb5ad6bf", "sha256": "2f01eececeac24e52b90f6e04e86957af3ebd30b2d5a213ec11da672dd6b999a" }, "downloads": -1, "filename": "speedoc-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "13d2ee19e227cd23b75d047acb5ad6bf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 4604, "upload_time": "2019-07-16T14:17:06", "url": "https://files.pythonhosted.org/packages/c3/27/fdfde00dbdb4a90a37b629a23c26e0a566641ef8f915012aafbfe08663a9/speedoc-0.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "13d2ee19e227cd23b75d047acb5ad6bf", "sha256": "2f01eececeac24e52b90f6e04e86957af3ebd30b2d5a213ec11da672dd6b999a" }, "downloads": -1, "filename": "speedoc-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "13d2ee19e227cd23b75d047acb5ad6bf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 4604, "upload_time": "2019-07-16T14:17:06", "url": "https://files.pythonhosted.org/packages/c3/27/fdfde00dbdb4a90a37b629a23c26e0a566641ef8f915012aafbfe08663a9/speedoc-0.2-py3-none-any.whl" } ] }