Metadata-Version: 2.1
Name: doks
Version: 1.0.1
Summary: Automatically generated READMEs
Home-page: https://github.com/rec/doks
Author: Tom Ritchford
Author-email: tom@swirly.com
License: MIT
Keywords: documentation
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: impall
Requires-Dist: pyyaml
Requires-Dist: readme-renderer
Requires-Dist: safer
Requires-Dist: toml

doks
----

Usage
=====

.. code-block:: bash

       doks [-h] [--auto] [--command] [--force] [--verbose] [--window WINDOW]
            [source] [target]

Description
===========

Write a .rst document for a single Python file

Positional arguments
====================

``source``
  .py file to create documentation for

``target``
  .rst file to write to. None means stdout

Optional arguments
==================

``-h``, ``--help``
  Show this help message and exit

``--auto``, ``-a``
  Automatically guess which files to read and write

``--command``, ``-c``
  Use command line help from executing source instead

``--force``, ``-f``
  Write .rst documentation even if it is malformed

``--verbose``, ``-v``
  Print more stuff

``--window WINDOW``, ``-w WINDOW``
  How many lines around an RST error to print (0 means "print
  everything")

(automatically generated by `doks <https://github.com/rec/doks/>`_ on 2021-01-10T17:42:40.617077)


