(index)=

# gp-libs

Test and documentation utilities for [git-pull](https://github.com/git-pull) projects.

::::{grid} 1 1 2 2
:gutter: 2 2 3 3

:::{grid-item-card} Quickstart
:link: quickstart
:link-type: doc
Install and get started in minutes.
:::

:::{grid-item-card} Documentation Doctests
:link: modules/doctest_docutils/index
:link-type: doc
Run examples from documentation files with `doctest_docutils`.
:::

:::{grid-item-card} Pytest Doctests
:link: modules/pytest_doctest_docutils/index
:link-type: doc
Collect `.rst`, `.md`, and Python doctests through pytest.
:::

:::{grid-item-card} Issue Links
:link: modules/linkify_issues/index
:link-type: doc
Turn `#123` into rendered issue links.
:::

:::{grid-item-card} Contributing
:link: project/index
:link-type: doc
Development setup, code style, release process.
:::

::::

## Install

```console
$ pip install gp-libs
```

```console
$ uv add gp-libs
```

## At a glance

Run doctests in [Markdown] and [reStructuredText] files:

```console
$ python -m doctest_docutils README.md -v
```

Auto-link issue references in [Sphinx] documentation:

```python
# conf.py
extensions = ["linkify_issues"]
issue_url_tpl = "https://github.com/myorg/myrepo/issues/{issue_id}"
```

```{toctree}
:hidden:

quickstart
modules/index
modules/doctest_docutils/index
modules/pytest_doctest_docutils/index
modules/linkify_issues/index
project/index
history
GitHub <https://github.com/git-pull/gp-libs>
```

[Sphinx]: https://www.sphinx-doc.org/
[Markdown]: https://commonmark.org/
[reStructuredText]: https://docutils.sourceforge.io/rst.html