semvec/pypi-packages huggingface dataset:
sphinxcontrib-lunrsearch 0.4
Instant search for Sphinx
License: MIT

This extension modifies the search box in Sphinx documentation
to show instant results as you type. It's particularly suited for
searching through APIs.

To get started, ``$ pip install sphinxcontrib-lunrsearch`` and then add ``'sphinxcontrib.lunrsearch'`` to the list
of extensions in your Sphinx ``conf.py`` file.

Options
-------

The following options can be set in conf.py:

- lunrsearch_highlight: bool

  Whether to highlight the seach term after navigating to a results.
  The default is ``False``.

Example
-------

.. image:: http://i.giphy.com/3o85xmqkbt14LuRcZO.gif
sphinxcontrib-autodoc-doxygen 0.7.0
Doxygen / Sphinx bridge, with autodoc and autosummary
License: MIT
Keywords: sphinx,doxygen

=============================
sphinxcontrib-autodoc_doxygen
=============================

.. image:: https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen.svg?branch=master
    :target: https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen

`Example Output <https://rawgit.com/rmcgibbo/sphinxcontrib-autodoc_doxygen/gh-pages/index.html>`_

This a (pre-alpha) extension for sphinx that to read and display Doxygen XML output. It is similar to
Breathe. The implementation extends ``sphinx.ext.autodoc`` and ``sphinx.ext.autosummary`` as closely as
possble.

Usage
-----
In your Sphinx ``conf.py`` add ``'sphinxcontrib.autodoc_doxygen'`` to the list of extensions, and set the
variable ``doxygen_xml`` to a string containing the path to the directory containing your Doxygen XML
output.

This adds the following RST directives. ::

  autodoxysummary
  autodoxyclass
  autodoxymethod
  autodoxyenum

Examples
--------

::

    .. autodoxysummary::
       :toctree: generated/
       :template: doxyclass.rst

       OpenMM::CustomIntegrator
       OpenMM::CustomCompoundBondForce

This produces the output shown `here <https://rawgit.com/rmcgibbo/sphinxcontrib-autodoc_doxygen/gh-pages/index.html>`_


Installation
------------
You can install it with pip (py27 or py33+)::

  pip install sphinxcontrib-autodoc_doxygen
  
The necessary dependences should be grabbed by ``pip``. If you have trouble getting lxml,
here are some tips:

If you use the `Anaconda <https://www.continuum.io/downloads>`_ Python
distribution, run ``conda install lxml``. With the system package manager on linux,
``sudo apt-get install python-lxml`` or ``sudo yum install python-lxml`` should do the trick.
On Windows, you may be able to download the lxml from `Christoph Gohlke's repository
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_. On OS X, try the following long command
``brew install libxslt libxml2; LDFLAGS="-L/usr/local/opt/libxslt/lib -L/usr/local/opt/libxml2/lib" CPPFLAGS="-I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include" pip install lxml``. It may take a
long time (~5 minutes), but once the wheel is built, it will be cache, so you only need
to do this once, even if switch virtualenvs.
abomination 0.2.0
A dumpster fire of metaprogramming and other Python abuses.
License: MIT
Requires Python: >=3.7

# abomination

*A dumpster fire of metaprogramming and other Python abuses.*

Some code is so bad it just has to be written, documented, tested, and packaged.
This is the place for such ideas.

## Installation

Install the package from pypi:

```sh
pip install abomination
```

## Usage

### Automatic installation of packages

Somewhere before your first third-party import, but the following line:

```py
import abomination; abomination.magic()
```

If an import fails, we will try to install the package with pip and restart the
script.

```py
import abomination; abomination.magic()

# This just works!
import numpy as np
```

Of course, this only works if the import name matches the distribution name.
Prepare for an ugly recursion while Python screams "I cannot import `pyyaml`!"
and pip shouts back "But I have already installed `pyyaml`!"
(note: the import name is `yaml`).

### Calling out code style you don't like

Linters are for the weak, *real* checks hit hard at run time!
Following the example of Python's treatment of whitespace,
code style violations raise a `SyntaxError` if you call `call_out`:

```py
import abomination

abomination.call_out(sadface=True)

# Some dummy code to provoke
if (
    this_code_uses_some_practices_that_i_dislike := True
    and others_should_know_about_it := True
):
    pass

```

Output:
```
SyntaxError: It saddens me to see '):' in your code :(
```

> This function, just like the whole package, is intended as a light-hearted joke.
> It was inspired by this twitter thread: https://twitter.com/gvanrossum/status/1395135889123069952
> If anyone involved feels offended, please contact me and I will remove it.