Metadata-Version: 2.1
Name: offline-docs
Version: 0.2.3
Summary: Downloads documentation of Python project dependencies for offline availability.
Author: top-on
Author-email: top-on@posteo.de
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: typer (>=0.4.0,<0.5.0)
Requires-Dist: urlpath (>=1.2.0,<2.0.0)
Requires-Dist: wget (>=3.2,<4.0)
Project-URL: repository, https://github.com/top-on/offline-docs
Description-Content-Type: text/markdown

# offline-docs

Downloads documentation of Python project dependencies for offline availability.


## Usage

```
$ offline-docs --help


Usage: offline-docs [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  clean   Remove all downloaded docs from disc.
  python  Download and show docs for the running version of Python.
```


## Related Projects

An overview of similar projects, and how `office-docs` is different:

### Zeal

Mission statement, according to [zealdocs.org](https://zealdocs.org/):

> *Zeal is an offline documentation browser for software developers.*

Compared to zeal, `offline-docs`: 
* provides a command-line interface,
* shows docs in the system's default browser,
* matches the versions of docs to the installed versions.

## Roadmap

This section gives an outlook on how `offline-docs` could develop in the future. 

* Replace `wget` dependency with `requests`.
* Download docs from [readthedocs.org](https://readthedocs.org).

