Commit graph

16 commits

Author SHA1 Message Date
Marcos Marado
0984fccafb fix: remove erroneous links from the documentation
Sphinx assumes that WORD.py should be a link to https://WORD.py .

This is not a problem in most of the documentation, since Sphinx won't
turn those python filenames into links when they are wrapped in
backticks, like `WORD.py`. Unfortunately, not always that was being
done, and so there were several wrong, broken links in the
documentation.

This patch wraps all the occurrences I've found of this case with
backticks, not only making the documentation more readible and
homogeneous, but more importantly getting rid of those unwanted links
in the generated HTML version of the documentation.
2024-10-26 17:45:14 +01:00
Griatch
98fa66b419 Spruce up the EvMenu tooltips a bit 2023-08-20 17:24:12 +02:00
Griatch
0749c3aa80 Add example diagram to Evmenu doc 2023-03-27 08:04:20 +02:00
Griatch
596a081a64 Fix evmenu doc example 2023-03-17 22:19:09 +01:00
Griatch
3b6f16f529 Cleaned up Components page 2022-11-26 23:18:11 +01:00
Griatch
77e78573ca Continue reworking/refactoring the tutorial docs 2022-11-22 00:12:59 +01:00
Griatch
a452434ba8 Revert "Updated HTML docs."
This reverts commit 06bc3c8bcd.
2022-11-15 20:46:50 +01:00
Griatch
06bc3c8bcd Updated HTML docs. 2022-11-15 19:43:25 +00:00
Griatch
6e4bb8047b Update docs to reference _evmenu rather than old _menutree NAttribute. Resolve #2731 2022-11-01 23:40:36 +01:00
Griatch
0095f70835 Working on docs 2022-09-14 18:40:21 +02:00
Griatch
628afe9367 Refactor 1.0 docs with new toctree structure and inheritance 2022-02-06 19:27:15 +01:00
Griatch
8a7ebf992b Fix caller reference in doc. Resolve #2296. 2022-02-05 23:00:45 +01:00
Griatch
95bc3427e2 Update EvMenu doc with more examples 2022-01-10 22:16:31 +01:00
Griatch
a51e4af609 Change to MyST parser 2021-10-26 21:31:20 +02:00
Dimitri
851ca30be5 issue #2243 -- prefer f-strings over %-interpolation
edited docs to prefer f-strings, then str.format(), and remove %-interpolation

additional ad-hoc documentation fixes, as opportunities seen:
- replace Built-In Function (BIF) "min" variable with "mins"
- prefer BIF str(var) over "%s" % var
- reformat some code examples to clarify multiple args passed to functions
- change some single-quote strings to double-quotes for consistency
- fix mismatched parens

misc edits:
- add .vscode/ to gitignore
2021-10-12 12:13:42 -06:00
Griatch
b5b265ec3b Doc refactor/renaming 2020-07-12 17:33:52 +02:00
Renamed from docs/source/Component/EvMenu.md (Browse further)