You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

doks

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

doks

Automatically generated READMEs

1.0.1
PyPI
Maintainers
1

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)

Keywords

documentation

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts