a tool to check/update simple file/shell examples in documentation

Project description

regendoc

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 ===============================

Project details

Release history Release notifications | RSS feed

This version

0.9.0

Oct 1, 2021

0.8.1

Sep 20, 2021

0.8.0

Sep 20, 2021

0.7.0 yanked

Sep 20, 2021

Reason this release was yanked:

release error

0.6.1

Sep 22, 2015

0.6

Sep 22, 2015

0.5

Jun 6, 2015

0.3

Jun 6, 2015

0.2.0

Mar 3, 2015

0.1

Oct 11, 2010

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

regendoc-0.9.0.tar.gz (15.4 kB view details)

Uploaded Oct 1, 2021 Source

Built Distribution

regendoc-0.9.0-py3-none-any.whl (12.9 kB view details)

Uploaded Oct 1, 2021 Python 3

File details

Details for the file regendoc-0.9.0.tar.gz.

File metadata

Download URL: regendoc-0.9.0.tar.gz
Upload date: Oct 1, 2021
Size: 15.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for regendoc-0.9.0.tar.gz
Algorithm	Hash digest
SHA256	`1c71d410c3cab002cb69e2413a4e5b4e5a6bccce2d3670344bf1faa57d5cec2f`
MD5	`2f48254e6004b9377678f7caa07117f9`
BLAKE2b-256	`408e18b0f781cdd855e94e009c8dff3586e610a4bdfc835cd3b812ba2af16542`

See more details on using hashes here.

File details

Details for the file regendoc-0.9.0-py3-none-any.whl.

File metadata

Download URL: regendoc-0.9.0-py3-none-any.whl
Upload date: Oct 1, 2021
Size: 12.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for regendoc-0.9.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`99998f768cc9cac4d92b855c9eff9259129b8f44f708bb19a7686b241c3b4389`
MD5	`7850bcf976826ff3270bf1f43cd529eb`
BLAKE2b-256	`dd6b521e3ec8d36ce5a091219f55732f7a880d30390d15f519fbd14d46e43791`