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.

0.1.1 - 0.1.4 (2023-07-09)

  • Bug Fixes

0.1.5 (2023-07-09)

  • Updated Readme with usage and example

0.1.6 (2023-07-09)

  • Added History

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.6.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

docs2txt-0.1.6-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: docs2txt-0.1.6.tar.gz
  • Upload date:
  • Size: 11.6 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.6.tar.gz
Algorithm Hash digest
SHA256 10e8268f47f79e9ecb1429a8f73547eb614ec59d3db41915bf6f7a5714ee355b
MD5 6e6eb86f11084413bf408983d07518fc
BLAKE2b-256 6b662a719d10ebd709a53cf31bb59a893d3ceed2cd258264d9695b9e45071e49

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: docs2txt-0.1.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.4 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.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 413b8a71193b9dd4669fce79171eda1fa4f40f971c527ef8fbf964819aabceea
MD5 5a8a6ed2eee456a9148f57fb21ca8126
BLAKE2b-256 ce6f83c50c5523053de2b1713a467322912d5e8555e58f2b514f99052c1ba6ad

See more details on using hashes here.

Provenance

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