Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace instructions in step 2 with a pure markdown solution #296

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rantahar
Copy link
Contributor

@rantahar rantahar commented Sep 18, 2024

As in issue #295

@rantahar rantahar marked this pull request as draft September 18, 2024 18:12
@rantahar
Copy link
Contributor Author

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
Copy link
Contributor Author

@rantahar
Copy link
Contributor Author

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.

content/sphinx.md Outdated Show resolved Hide resolved
Co-authored-by: Ashwin V. Mohanan <9155111+ashwinvis@users.noreply.github.com>
@rantahar rantahar marked this pull request as ready for review September 27, 2024 06:30
@rantahar rantahar requested review from ashwinvis and bast and removed request for ashwinvis September 27, 2024 06:30
@rantahar
Copy link
Contributor Author

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

@bast
Copy link
Member

bast commented Sep 29, 2024

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
Copy link

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

@bast
Copy link
Member

bast commented Sep 30, 2024

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants