From 527f80279354d9ee97719633c3818177ed08bce6 Mon Sep 17 00:00:00 2001 From: Glen Whitney Date: Sat, 30 Jan 2021 19:48:03 -0800 Subject: [PATCH] docs: Get mkdocs working --- docs/extra.css | 3 +++ mkdocs.yml | 6 ++++-- tests/basic.spt | 4 ++-- 3 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 docs/extra.css diff --git a/docs/extra.css b/docs/extra.css new file mode 100644 index 0000000..fddd6b4 --- /dev/null +++ b/docs/extra.css @@ -0,0 +1,3 @@ +ins { + text-decoration: underline; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 366fe2c..6726b34 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,15 +7,17 @@ nav: plugins: - search - semiliterate: - ignore_folders: [target] + ignore_folders: [target, lib] exclude_extensions: ['.o', '.hi'] extract_standard_markdown: terminate: theme: name: readthedocs + prev_next_buttons_location: both +extra_css: [extra.css] markdown_extensions: - attr_list -- markdown-del-ins +- markdown_del_ins - pymdownx.superfences - pymdownx.highlight: use_pygments: true diff --git a/tests/basic.spt b/tests/basic.spt index 096b213..6757d31 100644 --- a/tests/basic.spt +++ b/tests/basic.spt @@ -35,14 +35,14 @@ cloning this fostr project. Then, either: For example, this snippet generates the following Python: ```python -{! ../examples/emit_sum.py extract: +{! ../tests/emit_sum.py extract: start: 'Stdio\s=' !} ``` (which writes "192" to standard output), or this non-idiomatic, inefficient, but working Javascript: ```javascript -{! ../examples/emit_sum.js extract: +{! ../tests/emit_sum.js extract: start: '^}' !} ```