semvec/pypi-packages huggingface dataset:
speedoc 0.2
sphinx meets pydoc.
License: MIT
Requires Python: >=3

speedoc – sphinx meets pydoc
============================

Turn docstrings into man pages using Sphinx_, and view the result with ``man``.

.. _Sphinx: http://www.sphinx-doc.org

Installation
------------

.. code:: sh

   python -mpip install git+https://github.com/anntzer/speedoc

Tests can be run with pytest_.

.. _pytest: https://docs.pytest.org

Usage
-----

.. code:: sh

   speedoc [--opts ...] obj.to.document

Options are passed as is to ``python -msphinx``.  By default, ``sphinx`` is
invoked as

.. code:: sh

   # $tmpdir1, $tmpdir2 are set up by speedoc.
   # -bman: build a man page; -q: quietly
   python -msphinx $tmpdir1 $tmpdir2 -bman -q -Dextensions=sphinx.ext.napoleon

with a minimal ``conf.py`` that sets ``man_pages = [("contents", obj_name,
"\n", "", "3")]``.  To use, e.g., numpydoc_ instead of sphinx.ext.napoleon_,
call

.. code:: sh

   speedoc -Dextensions=sphinx.ext.autodoc,numpydoc obj.to.document

(With numpydoc≥0.9, it is not necessary anymore to explicitly load autodoc.)

Options to ``man`` can be passed by setting the (standard) ``MANOPT``
environment variable.  For example, justification can be disabled with

.. code:: sh

    MANOPT=--nj speedoc ...

.. _numpydoc: https://numpydoc.readthedocs.io
.. _sphinx.ext.autosummary: http://www.sphinx-doc.org/ext/autosummary.html
.. _sphinx.ext.napoleon: http://www.sphinx-doc.org/ext/napoleon.html

Troubleshooting
---------------

:Q: Docstrings are rendered terribly!
:A: Invalid RST formatting is very common :-(