Skip to content

Conversation

@ClimenteA
Copy link

@ClimenteA ClimenteA commented Mar 26, 2024

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.

@ClimenteA ClimenteA changed the title Rst compiler wip Rst compiler (WIP) Mar 26, 2024
@ClimenteA ClimenteA changed the title Rst compiler (WIP) RST compiler (WIP) Mar 26, 2024
@ClimenteA ClimenteA changed the title RST compiler (WIP) RST compiler (not needed only .md files are supported) Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant