معرفی شرکت ها
doc2dash-3.0.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
-
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | doc2dash-3.0.0 |
| نام | doc2dash |
| نسخه کتابخانه | 3.0.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Hynek Schlawack <hs@ox.cx> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/doc2dash/ |
| مجوز | MIT |
# doc2dash
*doc2dash* is an extensible [Documentation Set](https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/Documentation_Sets/010-Overview_of_Documentation_Sets/docset_overview.html#//apple_ref/doc/uid/TP40005266-CH13-SW6) (*docset*) generator that helps you to have documentation for all your favorite APIs in [*Dash.app*-compatible](https://kapeli.com/dash/) API browsers.
An API browser is an application that runs locally on your computer and allows you to search various API docs by pressing a key combination and starting to type (I have bound it to Alt-Space bar and can't write code without it).
The most common ones – [*Dash.app*](https://kapeli.com/dash) (macOS) and [*Zeal*](https://zealdocs.org) (Windows and Linux) – come with **many** docsets out of the box, but they can never offer you docsets for *every* package you'll ever use.
This is where *doc2dash* comes in:
It takes your offline documentation and converts it into an indexed format that API browsers can read and search (very fast!).
Currently it supports all known *intersphinx*-based documentation systems like [*Sphinx*](https://www.sphinx-doc.org/), [*pydoctor*](https://github.com/twisted/pydoctor), or [*MkDocs*](https://www.mkdocs.org) (with [*mkdocstrings*](https://mkdocstrings.github.io)).
While *doc2dash* is a Python project, the support is **not** limited to Python-related formats.
It's also extendable: [**you** can write your own parser](https://doc2dash.readthedocs.io/en/latest/extending/)!
## Project Information
- **License**: [MIT](https://github.com/hynek/doc2dash/blob/main/LICENSE)
- **PyPI**: <https://pypi.org/project/doc2dash/>
- **Source Code**: <https://github.com/hynek/doc2dash>
- **Documentation**: <https://doc2dash.rtfd.io/>
- **Changelog**: <https://github.com/hynek/doc2dash/blob/main/CHANGELOG.md>
- **Supported Python Versions**: 3.8 and later (check the changelog for past releases that support _much_ older Python versions)
- **Platforms**: pre-compiled **binaries** for **Linux**, **macOS**, and **Windows** available; also runs on everything that runs Python
## Release Information for [3.0.0](https://github.com/hynek/doc2dash/compare/2.4.1...3.0.0) - 2022-09-13
### Removed
- Since *pydoctor* added support for *intersphinx* in version 21.2.0, the dedicated HTML-parsing parser has been removed. If you need to parse legacy *pydoctor* docs, please use *doc2dash* 2.4.1.
### Added
- Stand-alone binaries! If your platform is supported, you can now download binaries from the release page without dealing with Python at all – courtesy of [*PyOxidizer*](https://pyoxidizer.readthedocs.io/).
- *intersphinx*: documentation based on [*MkDocs*](https://www.mkdocs.org/) with [*mkdocstrings*](https://mkdocstrings.github.io/) metadata is now supported.
- *intersphinx*: if no explicit name is passed, the docset name is derived von the documentation's metadata (and not the directory name, which is more often than not just `html`).
- We use [*rich*](https://rich.readthedocs.io/) for output and progress bars now. This allows us more granular progress indication.
- Documentation on writing your own parser plugins.
### Changed
- Tons of refactorings that probably broke your custom parsers. Sorry about that and let us know, if we can help you fixing them.
- *intersphinx*: We now parse `objects.inv` files on our own. *Sphinx* is not a dependency anymore.
- *intersphinx*: Files that are indexed by *intersphinx*, but don't exist aren't added to the docset anymore. Common example is `py-modindex.html`. [#113](https://github.com/hynek/doc2dash/issues/113) [#115](https://github.com/hynek/doc2dash/issues/115)
- We now check if the index page passed via `--index-page` / `-I` exists and fail if it doesn't.
## Credits
*doc2dash* is written and maintained by Hynek Schlawack and released under the [MIT license](https://github.com/hynek/doc2dash/blob/main/LICENSE).
The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/) and all my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).
A full list of contributors can be found on [GitHub's overview](https://github.com/hynek/doc2dash/graphs/contributors).
نیازمندی
| مقدار | نام |
|---|---|
| - | attrs>=21.3 |
| - | beautifulsoup4 |
| - | click |
| - | rich |
| xtr | doc2dash[tests,typing]; |
| xtr | mkdocs; |
| xtr | mkdocs-click; |
| xtr | mkdocs-include-markdown-plugin; |
| xtr | mkdocs-material; |
| xtr | mkdocstrings[python]; |
| xtr | coverage[toml]; |
| xtr | pytest; |
| xtr | mypy; |
| xtr | types-urllib3; |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8 | Python |
نحوه نصب
نصب پکیج whl doc2dash-3.0.0:
pip install doc2dash-3.0.0.whl
نصب پکیج tar.gz doc2dash-3.0.0:
pip install doc2dash-3.0.0.tar.gz