ethdebug / format

Smart contract debugging data format – Standards development working group
https://ethdebug.github.io/format/
47 stars 4 forks source link

Upload built Sphinx docs as artifact to allow previewing them on a PR #17

Closed cameel closed 1 year ago

cameel commented 1 year ago

To preview the docs you visit the action and download the zip with HTML docs. You can unpack and view index.html in a browser locally.

It would be more convenient if we could upload the directory directly, without packing it. That's what we do in Solidity on CircleCI, and there you can just go directly to index.html in the browser. Having a zip is less convenient but probably still good enough.

cameel commented 1 year ago

Yeah, it was that document not being in the index:

Warning: document isn't included in any toctree

Rebased and now it should pass checks.