search

ConaireD / TolimanWIP

WIP Toliman codes go here before being added to the main TOLIMAN github
Other
0 stars 0 forks source link

Consider `pytest-markdown`. #21

Closed Jordan-Dennis closed 1 year ago

Jordan-Dennis commented 1 year ago

Hi all, I have not decided how far I want to take the docs yet, but if I decide to do them properly then the pytest-markdown package might be a good option for ensuring the correctness of code snippets embedded in the docs. Regards Jordan.

Jordan-Dennis commented 1 year ago

As always there is another option for this called pytest-readme, but I think this is specific to the README.md, so I am not sure it is so useful.

Jordan-Dennis commented 1 year ago

So I think that I will use this given that I am going to write the tutorials in .md files. I have just discovered another plugin called pytest-md that generates an .md summary of the tests. I wonder if this interacts with the rest of the (many) plugins that I am using.

Jordan-Dennis commented 1 year ago

Nevermind, pytest-markdown requires an older version of pytest so I will not use it.

Jordan-Dennis commented 1 year ago

pytest-readme requires a conftest.py file in the directory of the README.md so that pretty much kills that idea.

Jordan-Dennis commented 1 year ago

Perhaps I can simply fork pytest-markdown and update the version number.

Jordan-Dennis commented 1 year ago

Never-mind. The package is no longer maintained so I will not add it as a dependency.