Metadata-Version: 2.1
Name: doks
Version: 0.10.0
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: 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

📚 doks: Automatic READMEs from code 📚
====================================================================

Reads the comments from your file and puts them into a servicable .rst
file.

Very suitable for single-file Python libraries that want to keep the code
and documentation in sync without issues

USAGE
-------

.. code-block:: bash

    doks my_file.py [README.rst]

API
---

``doks.doks.doks(source, target, auto=False, window=10, verbose=False)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(`doks/doks.py, 32-73 <https://github.com/rec/doks/blob/master/doks/doks.py#L32-L73>`_)

Print documentation for a file or module

ARGUMENTS
  source
    path to the Python file or module.

  target
    path to the output file or ``None``, in which case
    output is printed to stdout

  auto
    If true, automatically guess both source and target files

(automatically generated by `doks <https://github.com/rec/doks/>`_ on 2020-07-10T14:05:23.855160)


