Skip to content
This repository has been archived by the owner on May 13, 2022. It is now read-only.

JavaScript application README update #435

Open
eorituz opened this issue Feb 23, 2018 · 6 comments
Open

JavaScript application README update #435

eorituz opened this issue Feb 23, 2018 · 6 comments

Comments

@eorituz
Copy link
Contributor

eorituz commented Feb 23, 2018

The JavaScript related part of the microraiden documentation currently links to:

  1. https://github.com/raiden-network/microraiden/blob/master/microraiden/webui/microraiden/README.md
    and
  2. 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.

@andrevmatos
Copy link
Contributor

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.

@eorituz
Copy link
Contributor Author

eorituz commented Feb 23, 2018

Mhhh @andrevmatos what do you recommend to do?

@andrevmatos
Copy link
Contributor

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.

@ezdac
Copy link
Contributor

ezdac commented Feb 23, 2018

The webui-api-docs should go to the main docs anyway.
I'll look into this and see how to integrate it in sphinx.

@ezdac
Copy link
Contributor

ezdac commented Feb 23, 2018

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

@ezdac
Copy link
Contributor

ezdac commented Feb 27, 2018

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.

@ezdac ezdac removed their assignment Aug 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants