Skip to main content

A simple program to download documentation from docs.rs and convert it into a plaintext file.

Project description

docs2txt

https://img.shields.io/pypi/v/docs2txt.svg https://img.shields.io/travis/ehutzle/docs2txt.svg Documentation Status

A simple program to download documentation from docs.rs and convert it into a plaintext file.

Features

Rust

  • Download documentation from docs.rs and convert it into a plaintext file.

Usage

  • Create a virtual environment and install the package python -m venv venv

  • Install the package with pip install docs2txt

  • Activate the virtual environment
    • OSX / Linux: source venv/bin/activate

    • Windows: venv\Scripts\activate

  • Run the program:
    • python -m docs2txt

Examples

To download the documentation of the redb crate and save it to a folder on your desktop named “Rust Docs”:

  • python -m docs2txt docs-rs --url https://docs.rs/redb/1.0.4/redb/ --output-dir '~/Desktop/Rust Docs'

History

0.1.0 (2023-07-09)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docs2txt-0.1.5.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

docs2txt-0.1.5-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file docs2txt-0.1.5.tar.gz.

File metadata

  • Download URL: docs2txt-0.1.5.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for docs2txt-0.1.5.tar.gz
Algorithm Hash digest
SHA256 0b31118c9976db1c222c1591c2a26d7c3c84427d321b5061d77075fb6fe6882b
MD5 3e46f794ef0af7cfa8a8b4ea5351a658
BLAKE2b-256 b4e9b6b5ceb2b7944dde9c35b76f89e6861ab307c5f477d050e8b05c93f81020

See more details on using hashes here.

File details

Details for the file docs2txt-0.1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: docs2txt-0.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for docs2txt-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 43cfb817705d0297c24f38c842c92a93bcb8741fd07b29cfddc64f8b33cc9ba5
MD5 bee2d2c82588813c700c1c6959a14483
BLAKE2b-256 603789dd105b1a7bcc59b0bd48d3e7f08a82102da77de316943ce0e75f9873dc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page