RST compiler (not needed only .md files are supported) #75
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
ClimenteA
changed the title
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.
First attempt for sphinx support was to use an RST to HTML compiler. I choosed pandoc looks like this is a standard package for file conversions. Other npm packages with rst to html conversion were covering only the most basic declarations.
pandoc npm package didn't worked well. Currently, pandoc needs to be installed so rst to html to work, but we can create a wrapper around pandoc binary if RST support is needed at some point (markdown rules 😄 ).
RST compiler doesn't work on sphinx docs because of various sphinx addons which have their own placeholder declarations (see automodapi).
XML is the closest format which we can take, parse and generate our own html files.