Package license: MIT
Feedstock license: BSD 3-Clause
Summary: Convert docs to Dash.app
doc2dash: Create docsets for Dash.app and clones
.. image:: https://readthedocs.org/projects/doc2dash/badge/?version=stable :target: https://doc2dash.readthedocs.io/en/stable/?badge=stable :alt: Documentation Status
.. image:: https://codecov.io/github/hynek/doc2dash/branch/master/graph/badge.svg :target: https://codecov.io/github/hynek/doc2dash :alt: Test Coverage
doc2dash is an MIT-licensed extensible
Documentation Set_ generator intended to be used with the
Dash.app_ API browser for macOS or one of its many free
clones <https://doc2dash.readthedocs.io/en/latest/installation.html#viewer>_ for all relevant platforms.
If you’ve never heard of Dash.app, you’re missing out:
doc2dash it’s all your API documentation at your fingertips!
doc2dash\ ’s documentation lives at
Read the Docs, the code on GitHub.
It’s tested on Python 2.7, 3.4+, and PyPy.
Both Linux and macOS are tested although certain features are only available on macOS.
Documentation Set: https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/Documentation_Sets/010-Overview_of_Documentation_Sets/docset_overview.html#//apple_ref/doc/uid/TP40005266-CH13-SW6
Read the Docs: https://doc2dash.readthedocs.io/
InterSphinxParseris now open to extension.
- Support a
--parseroption to force the use of a custom parser class.
Full changelog <https://doc2dash.readthedocs.io/en/stable/changelog.html>_.
doc2dash is written and maintained by Hynek Schlawack.
The development is kindly supported by
Variomedia AG <https://www.variomedia.de/>_.
A full list of contributors can be found on
GitHub's overview <https://github.com/hynek/doc2dash/graphs/contributors>_.
Current build status
Current release info
doc2dash from the
conda-forge channel can be achieved by adding
conda-forge to your channels with:
conda config --add channels conda-forge
conda-forge channel has been enabled,
doc2dash can be installed with:
conda install doc2dash
It is possible to list all of the versions of
doc2dash available on your platform with:
conda search doc2dash --channel conda-forge
conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.
A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by CircleCI, AppVeyor and TravisCI it is possible to build and upload installable packages to the conda-forge Anaconda-Cloud channel for Linux, Windows and OSX respectively.
To manage the continuous integration and simplify feedstock maintenance
conda-smithy has been developed.
conda-forge.yml within this repository, it is possible to re-render all of
this feedstock's supporting files (e.g. the CI configuration files) with
conda smithy rerender.
For more information please check the conda-forge documentation.
feedstock - the conda recipe (raw material), supporting scripts and CI configuration.
conda-smithy - the tool which helps orchestrate the feedstock.
Its primary use is in the construction of the CI
and simplify the management of many feedstocks.
conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)
If you would like to improve the doc2dash recipe or build a new
package version, please fork this repository and submit a PR. Upon submission,
your changes will be run on the appropriate platforms to give the reviewer an
opportunity to confirm that the changes result in a successful build. Once
merged, the recipe will be re-built and uploaded automatically to the
conda-forge channel, whereupon the built conda packages will be available for
everybody to install and use from the
Note that all branches in the conda-forge/doc2dash-feedstock are
immediately built and any created packages are uploaded, so PRs should be based
on branches in forks and branches in the main repository should only be used to
build distinct package versions.
In order to produce a uniquely identifiable distribution: