reStructuredText format output #440
Open
Conversation
This file contains hidden or 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
|
@pseudomuto please review. I know that custom templates are supported, but I assume that solving the specific reStructuredText issues has value for more that one person. |
|
@paweld2 we are interested in rst support for the flyte.org project. Let us know if we can help test |
8 tasks
|
@paweld2 we used this for generating Flyte.org docs and works beautifully. @pseudomuto what would the process to get this checked in? |
pqn
reviewed
Feb 17, 2022
| @$(EXAMPLE_CMD) --doc_opt=html,example.html:Ignore* examples/proto/*.proto | ||
| @$(EXAMPLE_CMD) --doc_opt=json,example.json:Ignore* examples/proto/*.proto | ||
| @$(EXAMPLE_CMD) --doc_opt=markdown,example.md:Ignore* examples/proto/*.proto | ||
| @$(EXAMPLE_CMD) --doc_opt=restructuredtext,example.srt:Ignore* examples/proto/*.proto |
There was a problem hiding this comment.
Suggested change
| @$(EXAMPLE_CMD) --doc_opt=restructuredtext,example.srt:Ignore* examples/proto/*.proto | |
| @$(EXAMPLE_CMD) --doc_opt=restructuredtext,example.rst:Ignore* examples/proto/*.proto |
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.
A proposition for reStructuredText format output.
The output is compatible with sphinx. No content table is provided, because it is generated by sphinx.
HTML and Latex output tested.
The references and links are correctly matched:
".. _ref_NAME:" matches ":ref:
NAME"The tables are created in the CVS format.
It is not possible to create references to table row values, that is why for each scalar value a separate subsection is created.