{"repo":"provinzkraut/AutoPyTabs","free":true,"listed":false,"github":"https://github.com/provinzkraut/AutoPyTabs","clone":"git clone https://github.com/provinzkraut/AutoPyTabs.git","description":"Automatically generate code examples for different Python versions in mkdocs or Sphinx based documentations","language":"Python","stars":12,"topics":["mkdocs","python","documentation","markdown","markdown-extension","mkdocs-plugin","sphinx","sphinx-extension"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"AutoPyTabs Automatically generate code examples for different Python versions in mkdocs or Sphinx based documentations, or a plain markdown workflow, making use of the pymdown \"tabbed\" markdown extension for markdown, and sphinx{design} tabs for Sphinx. Rationale The problem 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. This, however, raises several problems: 1. Maintaining multiple versions of a single example is tedious and error-prone as they can easily become out of sync 2. Figuring out which examples need to be changed for which specific Python version is a labour intensive task 3. Dropping or adding support for Python versions requires revisiting every example in the documentation 4. Checking potentially 4 versions of a single example into VCS creates unnecessary noise Given those, it's no surprise that the current standard is to only show examples for the lowest supported version of Python. The solution AutoPyTabs aims to solve all of these problems by automatically generating versions (using the awesome ruff project) of code examples, targeting different Python versions at build-time , based ","default_branch":null,"files":null,"tree":[],"storefront":"/r/provinzkraut","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/provinzkraut/AutoPyTabs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}