docs2txt 0.1.6

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

docs2txt

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

• Free software: MIT license

• Documentation: https://docs2txt.readthedocs.io.

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