-
Notifications
You must be signed in to change notification settings - Fork 49
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
mystmd #1178
base: main
Are you sure you want to change the base?
mystmd #1178
Conversation
thewtex
commented
Jul 15, 2024
- docs: create myst.yml
- docs: run myst init --write-toc
- docs: toc tweaks
- docs: add dark logo
- docs: packages pagee myst re-formatting
myst init A pass at frontmatter fields. mv _static to static.
@agoose77 the docs have been converted to myst 🎉 🌮 less the api-docs. I am wondering if you have implemented any of the |
Hi @thewtex, this is cool! I'm currently working on a Sphinx plugin that generates MyST AST. The idea is that we would then natively embed this into a MyST-MD project. I think this won't use the same mechanism as the I have already tested it on your documentation, which is really exciting! We have a MyST developers meeting today at 3 PM BST. You'd be welcome to attend, although I suspect we won't be able to add much more than my discussion here just yet. In that meeting, though, we'll discuss next-steps for this work to figure out how best to tie it in to MyST-MD as a whole |
@agoose77 thanks for the note! Sorry I missed the meeting. Any other thoughts on next steps? |
Next steps are really all on our side. I'm building this out to work as nicely as possible. Here's the latest screenshot: https://discord.com/channels/1083088970059096114/1177359316886503464/1263870267604729876 |
@agoose77 thanks for the update. That discord link is not working for me. Any links to code 👨💻 📖 😄 ? |
Huh, maybe you need to join the discord first. In any case: Will need to do a pass to see what's not working, but:
|
A small update -- we've merged in some of these PRs (into mystmd), making it easier to get started. To try this out, you'd need to
|
I believe I tried to do this at some point, but I received a notice that it was only available for free for students at academic institutions or similar, which is not accessible to me. And I am not sure how to get that prompt up again.
Big update! Outstanding work, @agoose77 ! As I mentioned in the airport, I would like to forgo Sphinx altogether. As I understand it, the approach that you are taking is more general and provides a workable solution for other projects that are not necessarily using I also see references to Myst xref -- are there any documentation pointers on this that I can use to get a better understanding? Thank you, Angus! |
I found this myst-xref-json description and this Guide entry on External References, which also mentions Intersphinx |
If you really want to drop Sphinx and directly move to autodoc2, then you will want to think about where you pull in the docs. What I would suggest is generation of |
Great, thanks for the guidance @agoose77 🙏 Is there a plan to list the Python autodoc node types in the Myst Schema Node Type Index or someplace else? |
@thewtex the new plan is to avoid updating our AST by transforming the Spinx AST into MDAST nodes and adding some annotations (classes). |
@agoose77 cool, thanks for the clarification. |