Changelog#

To install the unreleased gp-libs version, see developmental releases.

pip:

$ pip install --user --upgrade --pre gp-libs

gp-libs 0.0.2 (2023-09-09)#

Breaking changes#

  • Python 3.7 Dropped (#23)

gp-libs 0.0.1 (2023-09-09)#

  • Add your latest changes from PRs here

New features#

  • linkify_issues: Automatically link

    conf.py:

    issue_url_tpl = 'https://github.com/git-pull/gp-libs/issues/{issue_id}'
    
  • doctest_docutils: :mod:doctest w/ docutils support (and markdown)

  • doctest_docutils: Support for sphinx-inline-tab’s tab directive was added in v0.0.1a17 (#18)

    ````{tab} example tab
    
    ```python
    >>> 4 + 4
    8
    ```
    
    ````
    
    ````{tab} example second
    
    ```python
    >>> 4 + 2
    6
    ```
    
    ````
    

Removed features#

  • sphinx_toctree_autodoc_fix was removed in v0.0.1a12

    Overcome by Sphinx 5.2 bakes this in by default:

    Settings options:

    • add_function_parentheses = False (default: True)

    • toc_object_entries_show_parents can be (default: 'domain'):

      • toc_object_entries_show_parents = 'domain'

      • toc_object_entries_show_parents = 'hide'

      • toc_object_entries_show_parents = 'all'

    See also:

    • https://github.com/sphinx-doc/sphinx/issues/6316

    • https://github.com/sphinx-doc/sphinx/pull/10807

    • https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f

Documentation#

  • Initial docs, packaging, etc.

Tests#

pytest-doctest-docutils:

  • Add tests for pytest conftest.py files (#9)

Infrastructure#

  • Ruff (additional linting rules): Added in #20 and #21

  • CI: docutils testgrid (#16)

  • CI speedups (#13)

    • Split out release to separate job so the PyPI Upload docker image isn’t pulled on normal runs

    • Clean up CodeQL

  • Poetry: Bump 1.1.x to 1.6.x