Open RonnyPfannschmidt opened 1 year ago
I'm currently on holidays. I'll look into this next week.
Thanks for the update and have a great holiday
i did some more investigation, and i'm under the impression that to replace regendoc as intended, the build hook might be needed with target files that get linked up with a entangled text block
also some ieda of "entangled project home might be needed" where temporary files drop and commands can run
``` { .python entangled-key=test-filter-example file="test_somthing.py" }
def test_fun():
...
$ COLUMNS=40 pytest test_something.py
========= test session starts ==========
platform linux -- Python 3.8.*, pytest-7.*.*, pluggy-*.*.*
rootdir: $PWD, configfile: tox.ini
plugins: xdist-3.2.1
collected 1 item
test_something.py . [100%]
========== 1 passed in 13.37s ===========
I have a plan to integrate a small build utility into Entangled, to replace the current Makefile
based build-hook. This would make things easier to work with on Windows and as an extra, it becomes much simpler to implement a system like the one you're referring to. This will take some time to implement though.
i was wondering if/how to use this tool as replacement for the https://github.com/pytest-dev/regendoc/ hack we currently use for pytest
off hand and without reading too deep into the project, its not clear to me how the examples written out in the docs play well together with output of tools that may take a while to run (and are best updated occasionally with choice)
in the case of pytest specifically, we also keep a cleaned up version of the output in the files so its easy to take note of unintended changes
FYI there are no immediate plans to change the documentation tooling of pytest, but i'm starting to investigate reasonable alternatives to ensure our use-cases can be covered or replaced in a sensible manner so eventually something nice can be proposed