search

ethpm / escape-truffle

Ethereum Package Registry (Truffle)
10 stars 8 forks source link

Improve doc generation. #4

Closed cgewecke closed 6 years ago

cgewecke commented 6 years ago

Have added solmd and a little script to generate markdown docs with 0c8e78ed18a489d8e3157424f1ed8028a13c8f19. This still needs work - pruning the import trees and adding public variables. See full output in RTD here.

Really like the way methods include their function signature hash.

screen shot 2018-04-28 at 8 59 19 pm

[EDIT] - Zeppelin's recently worked out a nice solution for this as well - worth checking out. It's looks somewhat coupled to docosaurus and we might want docs here to be integrated into a single EthPM RTD.

cgewecke commented 6 years ago

Now using Alan Lu's super nice sphinxcontrib-soliditydomain module. . . Closing.

Still like the solmd's formatting a lot. Might discuss cosmetic changes with him / see what he thinks / open a PR.