microraiden
microraiden copied to clipboard
JavaScript application README update
The JavaScript related part of the microraiden documentation currently links to:
- https://github.com/raiden-network/microraiden/blob/master/microraiden/webui/microraiden/README.md and
- https://github.com/raiden-network/microraiden/blob/master/microraiden/webui/microraiden/docs/README.md
This README is only needed once, therefore delete one of the READMEs.
Take care with it, because the second one is actually auto-generated by TypeDoc, and "import" the header for the README from the first one. There's one option from typedoc command to exclude this import, but I think the second, auto-generated readme gets more complete with it.
Mhhh @andrevmatos what do you recommend to do?
Hmm, not sure.. I'd view the 1st readme more as a template/header, and let it alone. The proper/actual/auto-generated docs are in the docs/
folder, so just export it alone.
The webui-api-docs should go to the main docs anyway. I'll look into this and see how to integrate it in sphinx.
This looks promising how to integrate in sphinx:
- Creating custom URL-Rules with typedoc-plugin-sourcefile-url if neccessary for compilation of the
.md
files - use
recommonmark
Markdown-parser plugin for sphinx
Unfortunately ---^ is not easily integratable in sphinx.
Best solution would be to modify the typedoc-markdown-theme and let it output .rst
files with appropriate toc-tree
and :doc:
-link directives inserted.
This should not be too hard, but takes some time.