.. code-block:: bash
doks [-h] [--auto] [--command] [--force] [--verbose] [--window WINDOW]
[source] [target]
Write a .rst document for a single Python file
source
.py file to create documentation for
target
.rst file to write to. None means stdout
-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)
FAQs
Automatically generated READMEs
We found that doks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.