search

bcgov / TheOrgBook

A public repository of verifiable claims about organizations. A key component of the Verifiable Organization Network.
http://von.pathfinder.gov.bc.ca
Apache License 2.0
78 stars 66 forks source link

Spike: ReadTheDocs for tob-web #770

Closed esune closed 5 years ago

esune commented 5 years ago

To better document tob-web, we could be looking into something like ReadTheDocs. Once the framework is set up, we will need to actually document (comment) the code.

See: https://github.com/mozilla/sphinx-js https://typedoc.org

esune commented 5 years ago

The typescript support for sphinx-js is still experimental (as stated in their readme), and it doesn't seem to work well with Angular applications. I was able to produce some kind of documentation using typedoc from the command line, but not when kicking it off using sphinx-js.

I will keep poking at it a bit, but at this point it doesn't look like it is be possible to use readthedocs with tob-web.

esune commented 5 years ago

@swcurran I confirm I wasn't able to get this to work with tob-web.