https://github.com/rec/doks

📚 Automatically create READMEs from your project 📚
https://github.com/rec/doks

Last synced: about 1 year ago
JSON representation

📚 Automatically create READMEs from your project 📚

• Host: GitHub
• URL: https://github.com/rec/doks
• Owner: rec
• License: mit
• Created: 2020-05-05T18:46:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-24T16:22:16.000Z (over 3 years ago)
• Last Synced: 2025-05-15T10:21:58.927Z (about 1 year ago)
• Language: Python
• Size: 117 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

          
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 `_ on 2021-01-10T17:42:40.617077)