from rST to Ema #665
jaygray0919
started this conversation in
General
Replies: 1 comment 1 reply
-
You can approach it in a couple of ways:
The latter is non-trivial effort and someone will have to volunteer it since I do no need reST support myself. Or, you can ditch Sphinx in favour of other documentation generator (eg: mdBook) that uses Markdown. You would still convert your documentation to Markdown, but now you can use either of the tools, depending on the purpose. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Srid, may I ask you a high-level question (acknowledging that the devil is in the detail)?
Here is the rST/Sphinx site using ReadTheDocs: https://nutrients.readthedocs.io/en/latest/index.html
Here is the GitHub repo used to build/rebuild the RTD site: https://github.com/gigster99/sph_doc
Here is a Sphinx-generated build on another domain: https://docs.ontomatica.io/index.html
We would like to have one core platform for our Neuron blog and our Sphinx documentation.
We would use Ema if we can manage the content migration and menu/navigation management from Neuron/Sphinx to Ema.
rST is a superset of markdown, but one that - as i remember - you've managed before in Neuron
One issue, which we are willing to work on, is the method to build menus to link pages.
The Sphinx
toc
(table of contents) file guides the generation of menus and linksIn Neuron, we handled links on a note-by-note basis (one note at a time) - a bottom-up, incremental approach
We would like to have the best of both worlds - a systematic menu design/generator and an incremental design where, like Neuron, we can add nodes to a network with little effort.
/jay
Beta Was this translation helpful? Give feedback.
All reactions