python3-auto-pytabs

Automatically generate code examples for mkdocs or Sphinx (Python 3)

Description

Python project documentation typically include code examples. Given that most of the time, a project will support multiple versions of Python, it would be ideal to showcase the adjustments that can or need to be made for different Python versions. This can be achieved by including several versions of the example code, conveniently displayed using the pymdown "tabbed" extension for markdown, or sphinx{design} tabs for Sphinx.

AutoPyTabs aims to solve all these problems by automatically generating versions (using the awesome ruff project) of code examples, targeting different Python versions at build-time, based on a base version (the lowest supported Python version). This means that:

 * There exists only one version of each example: The lowest supported version
   becomes the source of truth, therefore preventing out-of-sync examples and
   reducing maintenance burden.
 * Dropping or adding support for Python versions can be done via a simple
   change in a configuration file

This package installs the library for Python 3.

Upload more screenshots

Please help extend the collection of screenshots. Just make a screenshot and upload it here. You don't need to register or anything.

Upload a screenshot

Hint: upload an image here from your clipboard with Ctrl-V


Homepage

https://github.com/provinzkraut/AutoPyTabs


Install this software package

If the package is available for the distribution you are currently using on your computer then install the software by clicking on…

Install python3-auto-pytabs