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

🧙 Render new nodetypes for Sphinx autodoc #431

Closed
wants to merge 5 commits into from

Conversation

agoose77
Copy link
Collaborator

This PR adds some basic styling for mdast nodes emitted by https://github.com/executablebooks/sphinx-ext-mystmd

Copy link
Collaborator

@rowanc1 rowanc1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As these are specific for sphinx, are not used in scientific , and the AST might change. I think these should be their own package. Ideally we have them as an export out of myst-ext-autodoc/react?

Doing that makes it a bit harder to do the auto reload, but I think it is maybe worth it?

If we did that, then I still think these should come in by default in the themes we have, but other themes can make different choices.

packages/myst-to-react/src/autodoc.tsx Outdated Show resolved Hide resolved
packages/myst-to-react/src/autodoc.tsx Outdated Show resolved Hide resolved
packages/myst-to-react/src/autodoc.tsx Outdated Show resolved Hide resolved
packages/myst-to-react/src/autodoc.tsx Outdated Show resolved Hide resolved
Copy link

changeset-bot bot commented Jul 30, 2024

⚠️ No Changeset found

Latest commit: 71871c6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@rowanc1
Copy link
Collaborator

rowanc1 commented Jul 30, 2024

In conversation today: we should see how far we can get on doing a pre-transform on the AST to use kind to differentiate, e.g., a field list, on a definitionList.

@agoose77
Copy link
Collaborator Author

agoose77 commented Aug 1, 2024

Closed in favour of #443

@agoose77 agoose77 closed this Aug 1, 2024
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.

2 participants