-
Notifications
You must be signed in to change notification settings - Fork 197
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
Support for Pandoc/Rmarkdown-style [@citations] possible? #511
Comments
Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗 |
Hey @Anaphory, so at the moment no it does not, but I was actually playing around with this recently in https://github.com/executablebooks/MyST-Parser/tree/pop-bibliography and https://github.com/chrisjsewell/sphinx-glossary Currently, we rely on sphinxcontrib-bibtex for bibliographies; its great but, being an external extension, means you can't have this kind of integrated syntax. Ideally I would like to have a solution with this kind of syntax, but also that was not just restricted to reading bibtex files; supporting more common formats like JSON/YAML/TOML. But certainly integration with JOSS would be nice |
Out of interest, was there any other issues you had with JOSS integration? |
I haven't tried much yet, I'm still drafting the paper. I'll look in more detail later and keep you updated if I encounter any other discrepancies between Sphinx's assumptions and JOSS's. I don't know any of the internals of MyST and am not really a parser person, but if it turns out I can help with the implementation, I'll see what I can do. |
That's great cheers, yeh no worries, |
Actually, there is one: The paper assumes that all section headings are first-level headings. In my docs, I would of course want them to be h2 or lower. I assume I can tell Sphinx somewhere to shift all headings inside a specified MyST file down by N levels, but I haven't found one yet. Looking for it, I found the MyST optional syntax page, which suggests that existing |
yep, the parsing of
As in here, they would assume all H1? # H1
## H1
### H1 or you want to be able to do: # H2
## H3
### H4 |
This comment has been minimized.
This comment has been minimized.
Is there already a conceptual issue with this:
or does the issue ‘only’ start with which data source, how to parse it, which transformation, how to specify it, how to run it, and how the whole system interacts? |
Yep exactly, the basic concept is fine, it's just handling all cases like:
|
@chrisjsewell: Could myst simply support the rst feature "citations"? https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations It is basic but does what we currently need, i.e. named footnotes 🙂 |
Describe the problem/need and solution
Context
I am trying to integrate a JOSS paper into my documentation.
According to https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography citations are supposed to follow the Rmarkdown format:
Problem / Idea
Myst supports references, but there seems to be no way for
@handle
-style citations.Solution
Is it difficult to add support for this kind of reference elements? Would it break any compatibility assumptions?
Benefit
The Rmarkdown style of citations is not used only in JOSS, but I have seen it in other places, as well.
Guide for implementation
No response
Tasks and updates
No response
The text was updated successfully, but these errors were encountered: