Archipelago/docs
Natalie Weizenbaum c61505baf6
WebHost/Core/Lingo: Render option documentation as reStructuredText in the WebView (#3511)
* Render option documentation as reStructuredText in the WebView

This means that options can use the standard Python documentation
format, while producing much nicer-looking documentation in the
WebView with things like emphasis, lists, and so on.

* Opt existing worlds out of rich option docs

This avoids breaking the rendering of existing option docs which were
written with the old plain text rendering in mind, while also allowing
new options to default to the rich text rendering instead.

* Use reStructuredText formatting for Lingo Options docstrings

* Disable raw and file insertion RST directives

* Update doc comments per code review

* Make rich text docs opt-in

* Put rich_text_options_doc on WebWorld

* Document rich text API

* Code review

* Update docs/options api.md

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* Update Options.py

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

---------

Co-authored-by: Chris Wilson <chris@legendserver.info>
Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>
2024-06-14 18:53:42 -04:00
..
img Docs: adding games rework (#2892) 2024-03-29 01:31:59 +01:00
network diagram Docs: Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections (#1782) 2023-06-26 08:53:44 +02:00
CODEOWNERS CODEOWNERS: Replace @ThePhar with @qwint as Hollow Knight maintainer. (#3508) 2024-06-10 18:55:02 -05:00
adding games.md Docs: adding games rework (#2892) 2024-03-29 01:31:59 +01:00
apworld specification.md Docs: minor updates to recommend modern PEP8 (#2384) 2023-11-15 17:07:42 +01:00
code_of_conduct.md Docs: code_of_conduct.md (#1350) 2023-01-07 10:24:41 +01:00
contributing.md Docs: improve contributing sign posting (#2888) 2024-05-29 03:46:17 +02:00
network protocol.md Core: Remove Universally Unique ID Requirements (Per-Game Data Packages) (#1933) 2024-06-01 06:07:13 -05:00
options api.md WebHost/Core/Lingo: Render option documentation as reStructuredText in the WebView (#3511) 2024-06-14 18:53:42 -04:00
running from source.md Docs: remove obsolete yaml generation info (#3304) 2024-05-17 01:26:43 +02:00
settings api.md Core, Webhost, Docs: Replace all usages of player settings (#3067) 2024-04-06 19:25:26 -04:00
style.md Docs: style: multiline brackets (#3143) 2024-04-20 19:42:27 -05:00
tests.md Docs: Add documentation on writing and running tests (#2348) 2023-12-01 10:26:27 +01:00
triage role expectations.md Docs: Triage role expectations documentation. (#2325) 2023-10-18 15:11:25 -05:00
webhost configuration sample.yaml WebHost: remove JSON_AS_ASCII (#3209) 2024-04-24 06:36:35 +02:00
world api.md WebHost/Core/Lingo: Render option documentation as reStructuredText in the WebView (#3511) 2024-06-14 18:53:42 -04:00
world maintainer.md Docs: Create `CODEOWNERS` document for tracking world maintainers. (#1901) 2023-07-27 09:12:06 -05:00