<commit_before>Requirements and Installation
=============================

The latest stable version can be always found on PyPI_.

.. warning::

   Since ``doc2dash`` is an application, it has hard-coded dependency versions.
   I strongly discourage from installing it into your global ``site-packages`` because it will inevitably lead to conflicts_.
   Either use pipsi_ or create a virtualenv_ by hand.


``doc2dash`` runs on Python 2.7, and 3.4+, and PyPy.
Both Linux and macOS are supported although certain features are only available on macOS.

.. note::

   For best performance when converting large pieces documentation, I *strongly* recommend using PyPy as the interpreter of choice.


.. _clones:

Viewer
------

To view the results, you will need a docset viewer, the most commonly known being `Dash.app`_ for macOS.

Other alternatives have been developed in cooperation with Dash.app's developer `Kapeli <https://twitter.com/kapeli>`_:

- `helm-dash <https://github.com/areina/helm-dash>`_ for Emacs,
- `lovelydocs <http://lovelydocs.io/>`_ for Android,
- `velocity <http://velocity.silverlakesoftware.com/>`_ for Windows,
- and `zeal <https://zealdocs.org/>`_ for Linux and Windows.

``doc2dash`` is only tested against the original Dash.app though.


.. _pip: https://pip.pypa.io/en/latest/installing.html
.. _PyPI: https://warehouse.python.org/project/doc2dash/
.. _`Dash.app`: https://kapeli.com/dash/
.. _pipsi: https://github.com/mitsuhiko/pipsi
.. _virtualenv: https://virtualenv.readthedocs.org/
.. _conflicts: https://hynek.me/articles/virtualenv-lives/<commit_msg>Seems like lovelydocs is not a thing anymore<commit_after>Requirements and Installation
=============================

The latest stable version can be always found on PyPI_.

.. warning::

   Since ``doc2dash`` is an application, it has hard-coded dependency versions.
   I strongly discourage from installing it into your global ``site-packages`` because it will inevitably lead to conflicts_.
   Either use pipsi_ or create a virtualenv_ by hand.


``doc2dash`` runs on Python 2.7, and 3.4+, and PyPy.
Both Linux and macOS are supported although certain features are only available on macOS.

.. note::

   For best performance when converting large pieces documentation, I *strongly* recommend using PyPy as the interpreter of choice.


.. _clones:

Viewer
------

To view the results, you will need a docset viewer, the most commonly known being `Dash.app`_ for macOS.

Other alternatives have been developed in cooperation with Dash.app's developer `Kapeli <https://twitter.com/kapeli>`_:

- `helm-dash <https://github.com/areina/helm-dash>`_ for Emacs,
- `velocity <http://velocity.silverlakesoftware.com/>`_ for Windows,
- and `zeal <https://zealdocs.org/>`_ for Linux and Windows.

``doc2dash`` is only tested against the original Dash.app though.


.. _pip: https://pip.pypa.io/en/latest/installing.html
.. _PyPI: https://warehouse.python.org/project/doc2dash/
.. _`Dash.app`: https://kapeli.com/dash/
.. _pipsi: https://github.com/mitsuhiko/pipsi
.. _virtualenv: https://virtualenv.readthedocs.org/
.. _conflicts: https://hynek.me/articles/virtualenv-lives/
{'fraction_non_alphanumeric': 0.13267891070297658, 'fraction_numerical': 0.00506649778340722, 'mean_word_length': 4.0625, 'pattern_counts': {'":': 0, '<': 12, '<?xml version=': 0, '>': 12, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1318117', 'n_tokens_mistral': 1002, 'n_tokens_neox': 935, 'n_words': 330}