gp-libs

Test and documentation utilities for git-pull projects.

Quickstart

Install and get started in minutes.

Quickstart
Documentation Doctests

Run examples from documentation files with doctest_docutils.

doctest_docutils
Pytest Doctests

Collect .rst, .md, and Python doctests through pytest.

pytest_doctest_docutils
Issue Links

Turn #123 into rendered issue links.

linkify_issues
Contributing

Development setup, code style, release process.

Project

Install

$ pip install gp-libs

$ uv add gp-libs

At a glance

Run doctests in Markdown and reStructuredText files:

$ python -m doctest_docutils README.md -v

Auto-link issue references in Sphinx documentation:

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