ponylang / pony-tutorial

:horse: Tutorial for the Pony programming language
http://tutorial.ponylang.io
BSD 2-Clause "Simplified" License
308 stars 111 forks source link

Few notes on generating doc #514

Closed skull-squadron closed 1 year ago

skull-squadron commented 1 year ago
  1. Generate doc in ReadTheDoc .md format without creating a binary: ponyc --docs-public --pass=docs .... (Note: it documents everything, including built-in types. --docs-public only skips doc for private entries.)

  2. Install deps to convert them to HTML: pip3 install mkdocs mkdocs-material

3a. Either build static HTML docs for hosting on a webserver: cd {{target}}-docs && mkdocs build -> {{target}}-docs/site

3b. Or serve them locally: cd {{target}}-docs && mkdocs serve (existing tutorial step)

SeanTAllen commented 1 year ago

This isn't an actionable item. The issues aren't a notepad.