-
Notifications
You must be signed in to change notification settings - Fork 196
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
Add Footnote Syntax #117
Closed
Closed
Add Footnote Syntax #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The only thing that I now recall could do with improving, is the number ordering of footnote references that are in directives. The issue here is that
Instead of using this list, I probably need to do a final walk of the docutils syntax tree, and record the referencing order. |
This allows markdown parsing errors to be logged to sphinx.
rebased for merge in #119 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces footnote syntax to close #98. It also partially addresses #113 and #116
The actual
Footnote
andFootnoteReference
markdown tokens are implemented upstream inmistletoe-ebp
:Important: As the new documentation notes, this syntax currently only supports single line footnote definitions. Multiline footnote definitions will be addressed in a later PR.
For the docutils rendering, In my test I noted that, for rST, docutils/sphinx actually seems to handle these pretty poorly;
In the sphinx doc, they suggest putting them under a header. But I don't see that being an intuitive approach to footnotes.
Therefore, I have 'fixed' all these issues, as you can see in the test example.
tests/test_sphinx/sourcedirs/footnotes/footnote_rst.rst:
tests/test_sphinx/sourcedirs/footnotes/footnote_md.md:
New user documentation of the syntax is here:
https://272-240151150-gh.circle-artifacts.com/0/html/using/syntax.html#footnotes,
and I also improved other aspects of it; turning the syntax lists into tables: https://272-240151150-gh.circle-artifacts.com/0/html/using/syntax.html#block-tokens (I'm sure @choldgraf will appreciate 😄)
@mmcky @rossbar @najuzilu @akhmerov have a look at the above documentation and see what you think!