Internal utilities for projects following git-pull python package spec
Project description
gp-libs · 
Incubating / dogfooding some sphinx extensions and pytest plugins on git-pull projects, e.g. cihai, vcs-python, or tmux-python.
doctest for reStructured and markdown
Two components:
-
doctest_docutilsmodule: Same specification asdoctest, but can parse reStructuredText and markdown -
pytest_doctest_docutils: Pytest plugin, collects test items for pytest for reStructuredText and markdown filesThis means you can do:
$ pytest docs
doctest module
This extends standard library doctest to support anything docutils can parse.
It can parse reStructuredText (.rst) and markdown (.md).
See more: https://gp-libs.git-pull.com/doctest/
Supported styles
It supports two barebones directives:
-
docutils'
doctest_block>>> 2 + 2 4
-
.. doctest::directivereStructuredText:
.. doctest:: >>> 2 + 2 4
Markdown (requires myst-parser):
```{doctest} >>> 2 + 2 4 ```
Usage
The doctest_docutils module preserves standard library's usage conventions:
reStructuredText
$ python -m doctest_docutils README.rst -v
That's what doctest does by design.
Markdown
If you install myst-parser, doctest will run on .md files.
$ python -m doctest_docutils README.md -v
pytest plugin
This plugin disables pytest's standard doctest plugin.
This plugin integrates with the doctest_docutils module with pytest to enable seamless testing of docs, conftest.py fixtures and all.
$ pytest docs/
Like the above module, it supports docutils' own doctest_block and a basic
.. doctest:: directive.
See more: https://gp-libs.git-pull.com/doctest/pytest.html
sphinx plugins
Plain-text issue linker (linkify-issues)
We need to parse plain text, e.g. #99999, to point to the project tracker at https://github.com/git-pull/gp-libs/issues/99999. This way the markdown looks good anywhere you render it, including GitHub and GitLab.
Configuration
In your conf.py:
-
Add
'linkify_issues'toextensionsextensions = [ # ... "linkify_issues", ]
-
Configure your issue URL,
issue_url_tpl:# linkify_issues issue_url_tpl = 'https://github.com/git-pull/gp-libs/issues/{issue_id}'
The config variable is formatted via {meth}
str.formatwhereissue_idis42if the text is #42.
See more: https://gp-libs.git-pull.com/linkify_issues/
Table of contents for autodoc
sphinx.ext.autodoc doesn't link objects in the table of contents. So we need a
plugin to help.
See more: https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/
Configuration
-
Add
'sphinx_toctree_autodoc_fix'toextensionsextensions = [ # ... "sphinx_toctree_autodoc_fix", ]
Install
$ pip install --user gp-libs
Developmental releases
You can test the unpublished version of g before its released.
-
pip:
$ pip install --user --upgrade --pre gp-libs
More information
- Python support: >= 3.7, pypy
- Source: https://github.com/git-pull/gp-libs
- Docs: https://gp-libs.git-pull.com
- Changelog: https://gp-libs.git-pull.com/history.html
- Issues: https://github.com/git-pull/gp-libs/issues
- Test Coverage: https://codecov.io/gh/git-pull/gp-libs
- pypi: https://pypi-hypernode.com/pypi/gp-libs
- License: MIT.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file gp-libs-0.0.1a10.tar.gz.
File metadata
- Download URL: gp-libs-0.0.1a10.tar.gz
- Upload date:
- Size: 19.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 54fbe07f42628b114f0b1472bb03ce75be2928090ec26d8d6f675f3bd9f58c2e |
|
| MD5 | b8e3bd08ca452559ad4023fcecf4e454 |
|
| BLAKE2b-256 | 0358ca72f22c582abbf343f3e5cc0254617de6673ec762777049112ac038c582 |
File details
Details for the file gp_libs-0.0.1a10-py3-none-any.whl.
File metadata
- Download URL: gp_libs-0.0.1a10-py3-none-any.whl
- Upload date:
- Size: 16.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 701b190ffd468ca4d776b196707344748dd550aea03db9aaa1ffdecdd0c32506 |
|
| MD5 | 7e0211e38b60098cdf48fafdba409cdb |
|
| BLAKE2b-256 | 774e203f01ce3409cbff0a37c9ab659bab557db836bfafc791617301d224e4b0 |
