Skip to main content

doks

Usage

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)

Metadata

Release files for doks 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doks 1.0.1
File Size Uploaded Provenance Actions
doks-1.0.1.tar.gz 21.4 kB Without provenance Details for doks-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for doks 1.0.1
File Interpreter ABI Platform Actions
doks-1.0.1-py3-none-any.whl Python 3 none any Details for doks-1.0.1-py3-none-any.whl

Total release size: 40.2 kB

Release files / doks-1.0.1.tar.gz

Download URL doks-1.0.1.tar.gz
Size 21.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2ea8f658d273d9d57f9a0239a10a39905b8ba2e3eb925a8f2eb70932b5aa4488
BLAKE2b-256 checksum
How to use checksums
256da3e85f8a1e96f5427aa6c3825cf49a0bae40f14bf943599e24bcce51b7e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.6

Release files / doks-1.0.1-py3-none-any.whl

Download URL doks-1.0.1-py3-none-any.whl
Size 18.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
950f002b6cefe46ed08bc25cac5e1bd58585aa4533d603a98c3e2c1604056a18
BLAKE2b-256 checksum
How to use checksums
b6c6b947f825dd2838d01d6fa1f48b85630165cf4bfe1370c9e3c48b9c707e4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.6

Security for doks 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page