aka / solidity-dash

Solidity docset generation for Dash

Solidity Docset

This contains the docset generator for the last version of Solidity for Dash. Possibly for Zeal as well.

How to

• Clone the repo and cd into it
• Executing bash setup.sh will:
  • Try to install dependencies (see below)
  • Fetch the ethereum repo
  • Go to docs dir and make them into html
  • Copy them to solidity.docset
  • Copy info.plist, dsidx and icon.svg into solidity.docset
  • Run populate.py to iterate through the htmls and fill the db.

Dependencies

npm, pip to install dependencies.

• Sphinx, ethereum docs engine
• BeautifulSoup, to extract html tags.
• svgexport, since icon is in svg format.

To do

• Improve the html tag search in populate.py
• Generate the docset for the last 3 versions
  • 0.4.19
  • 0.4.18
  • 0.4.17

Author: Oscar Chavez