{"id":17800411,"url":"https://github.com/anntzer/speedoc","last_synced_at":"2026-01-03T12:04:39.364Z","repository":{"id":57469791,"uuid":"109939000","full_name":"anntzer/speedoc","owner":"anntzer","description":"sphinx meets pydoc","archived":false,"fork":false,"pushed_at":"2024-09-06T17:36:06.000Z","size":46,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-27T23:29:26.324Z","etag":null,"topics":["pydoc","sphinx-doc"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anntzer.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-08T06:52:42.000Z","updated_at":"2024-09-06T17:36:10.000Z","dependencies_parsed_at":"2024-10-27T12:47:45.950Z","dependency_job_id":"670405d7-e3c9-420c-b4b5-cd44c6a173ea","html_url":"https://github.com/anntzer/speedoc","commit_stats":{"total_commits":27,"total_committers":1,"mean_commits":27.0,"dds":0.0,"last_synced_commit":"442d35b6770be19995761ed12ad6a81b430b3309"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fspeedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fspeedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fspeedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fspeedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anntzer","download_url":"https://codeload.github.com/anntzer/speedoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858694,"owners_count":20359401,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pydoc","sphinx-doc"],"created_at":"2024-10-27T12:21:30.386Z","updated_at":"2026-01-03T12:04:39.292Z","avatar_url":"https://github.com/anntzer.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"speedoc – sphinx meets pydoc\n============================\n\n|PyPI|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/speedoc.svg\n   :target: https://pypi.python.org/pypi/speedoc\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≥0.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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanntzer%2Fspeedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanntzer%2Fspeedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanntzer%2Fspeedoc/lists"}