re-render examples in documentation
regendoc copies examples from documentation into custom folders and renders it
.. code:: python
# content of example.py
def test_fun():
pass
.. code:: text
$ pytest example.py
============================= test session starts ==============================
platform linux -- Python 3.9.7, pytest-6.3.0.dev685+g581b021aa.d20210918, py-1.10.0, pluggy-1.0.0
rootdir: /path/to/example
plugins: hypothesis-6.14.8
collected 1 item
example.py . [100%]
============================== 1 passed in 0.01s ===============================
FAQs
a tool to check/update simple file/shell examples in documentation
We found that regendoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.