Archipelago/worlds/lingo
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
..
data Lingo: Minor logic fixes (part 2) (#3250) 2024-05-23 02:09:52 +02:00
docs Docs: replacing "setting" to "option" in world docs (#2622) 2024-03-22 17:46:14 +01:00
test Accounting for name change (#3449) 2024-06-03 16:36:51 +02:00
utils Lingo: Minor logic fixes (part 2) (#3250) 2024-05-23 02:09:52 +02:00
__init__.py WebHost/Core/Lingo: Render option documentation as reStructuredText in the WebView (#3511) 2024-06-14 18:53:42 -04:00
datatypes.py Lingo: Minor logic fixes (part 2) (#3250) 2024-05-23 02:09:52 +02:00
items.py Lingo: The Pilgrim Update (#2884) 2024-04-18 18:45:33 +02:00
locations.py Lingo: Minor logic fixes (part 2) (#3250) 2024-05-23 02:09:52 +02:00
options.py WebHost/Core/Lingo: Render option documentation as reStructuredText in the WebView (#3511) 2024-06-14 18:53:42 -04:00
player_logic.py Lingo: Fix Basement access with THE MASTER (#3231) 2024-06-03 03:51:27 -05:00
regions.py Lingo: Fix Basement access with THE MASTER (#3231) 2024-06-03 03:51:27 -05:00
rules.py Lingo: Fix Basement access with THE MASTER (#3231) 2024-06-03 03:51:27 -05:00
static_logic.py Lingo: Fix world load on frozen 3.8 (#3220) 2024-04-29 20:38:29 +02:00