=============
docs2txt
=============
.. image:: https://img.shields.io/pypi/v/docs2txt.svg
:target: https://pypi.python.org/pypi/docs2txt
.. image:: https://img.shields.io/travis/ehutzle/docs2txt.svg
:target: https://travis-ci.com/ehutzle/docs2txt
.. image:: https://readthedocs.org/projects/docs2txt/badge/?version=latest
:target: https://docs2txt.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
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
Raw data
{
"_id": null,
"home_page": "https://github.com/ehutzle/docs2txt",
"name": "docs2txt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "docs2txt",
"author": "Eric Richard",
"author_email": "ehutzle@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6b/66/2a719d10ebd709a53cf31bb59a893d3ceed2cd258264d9695b9e45071e49/docs2txt-0.1.6.tar.gz",
"platform": null,
"description": "=============\ndocs2txt\n=============\n\n\n.. image:: https://img.shields.io/pypi/v/docs2txt.svg\n :target: https://pypi.python.org/pypi/docs2txt\n\n.. image:: https://img.shields.io/travis/ehutzle/docs2txt.svg\n :target: https://travis-ci.com/ehutzle/docs2txt\n\n.. image:: https://readthedocs.org/projects/docs2txt/badge/?version=latest\n :target: https://docs2txt.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n\n\nA simple program to download documentation from docs.rs and convert it into a plaintext file.\n\n\n* Free software: MIT license\n* Documentation: https://docs2txt.readthedocs.io.\n\n\nFeatures\n--------\n\nRust\n^^^^\n- Download documentation from docs.rs and convert it into a plaintext file.\n\nUsage\n-----\n- Create a virtual environment and install the package ``python -m venv venv``\n- Install the package with ``pip install docs2txt``\n- Activate the virtual environment\n - OSX / Linux: ``source venv/bin/activate``\n - Windows: ``venv\\Scripts\\activate``\n\n- Run the program:\n - ``python -m docs2txt``\n\nExamples\n--------\n\nTo download the documentation of the redb crate and save it to a folder on your desktop named \"Rust Docs\":\n\n- ``python -m docs2txt docs-rs --url https://docs.rs/redb/1.0.4/redb/ --output-dir '~/Desktop/Rust Docs'``\n\n\n\n=======\nHistory\n=======\n\n0.1.0 (2023-07-09)\n------------------\n\n* First release on PyPI.\n\n0.1.1 - 0.1.4 (2023-07-09)\n--------------------------\n\n* Bug Fixes\n\n0.1.5 (2023-07-09)\n------------------\n\n* Updated Readme with usage and example\n\n0.1.6 (2023-07-09)\n------------------\n\n* Added History\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A simple program to download documentation from docs.rs and convert it into a plaintext file.",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/ehutzle/docs2txt"
},
"split_keywords": [
"docs2txt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce6f83c50c5523053de2b1713a467322912d5e8555e58f2b514f99052c1ba6ad",
"md5": "5a8a6ed2eee456a9148f57fb21ca8126",
"sha256": "413b8a71193b9dd4669fce79171eda1fa4f40f971c527ef8fbf964819aabceea"
},
"downloads": -1,
"filename": "docs2txt-0.1.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a8a6ed2eee456a9148f57fb21ca8126",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 6391,
"upload_time": "2023-07-09T23:15:17",
"upload_time_iso_8601": "2023-07-09T23:15:17.994428Z",
"url": "https://files.pythonhosted.org/packages/ce/6f/83c50c5523053de2b1713a467322912d5e8555e58f2b514f99052c1ba6ad/docs2txt-0.1.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b662a719d10ebd709a53cf31bb59a893d3ceed2cd258264d9695b9e45071e49",
"md5": "6e6eb86f11084413bf408983d07518fc",
"sha256": "10e8268f47f79e9ecb1429a8f73547eb614ec59d3db41915bf6f7a5714ee355b"
},
"downloads": -1,
"filename": "docs2txt-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "6e6eb86f11084413bf408983d07518fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11610,
"upload_time": "2023-07-09T23:15:19",
"upload_time_iso_8601": "2023-07-09T23:15:19.461248Z",
"url": "https://files.pythonhosted.org/packages/6b/66/2a719d10ebd709a53cf31bb59a893d3ceed2cd258264d9695b9e45071e49/docs2txt-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 23:15:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ehutzle",
"github_project": "docs2txt",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "docs2txt"
}
JSON
