Replace instructions in step 2 with a pure markdown solution

[rantahar]

As in issue #295

[rantahar]

When I test this now, it does not seem to work. On stream it seemed fine, but maybe I did not reload the page?

The directive is not recognized at all. When I replace ::: with ```, it is recognized by the api documentation page is not generated correcty.

[rantahar]

It seems we would need sphinx-autodoc2. See https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#documenting-whole-apis

[rantahar]

Updated to use autodoc2. It's a bit different, but not really more complicated. Sphinx-autodoc2 would need to be added to the coderefinery environment for this to work.

[rantahar]

Marked ready for review, but we need to add sphinx-autodoc2 to the coderefinery environment

[bast]

But how about #293? Have you tried that one? I find it easier to use. Sorry I wasn't around in time to point it out earlier.

[ashwinvis]

on autodoc2 vs autoapi
https://github.com/sphinx-extensions2/sphinx-autodoc2?tab=readme-ov-file#design-and-comparison-to-sphinx-autoapi

[bast]

on autodoc2 vs autoapi https://github.com/sphinx-extensions2/sphinx-autodoc2?tab=readme-ov-file#design-and-comparison-to-sphinx-autoapi

Thank you for the explanation/comparison!

[bast]

Thank you for the work and wait!