From 26b03f6944161f1f3f8ef0f21043926a43ffec18 Mon Sep 17 00:00:00 2001 From: Jose Rodriguez Date: Sun, 17 Nov 2024 19:32:07 +0100 Subject: [PATCH 1/3] docs: try python superfences for better code blocks --- .readthedocs.yaml | 4 ++++ mkdocs.yml | 9 +++++++-- requirements.txt | 29 +++++++++++++++++++++++++++++ 3 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 249993a7e..2f9fb707c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,6 +11,10 @@ build: tools: python: "3.11" +python: + install: + - requirements: ./requirements.txt + # Build documentation in the docs/ directory with mkdocs mkdocs: configuration: mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml index ea6895367..42f2a3bd8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,11 @@ theme: docs_dir: docs markdown_extensions: - - fenced_code - tables - + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..da73f4437 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,29 @@ +babel==2.16.0 +certifi==2024.8.30 +charset-normalizer==3.4.0 +click==8.1.7 +colorama==0.4.6 +ghp-import==2.1.0 +idna==3.10 +Jinja2==3.1.4 +Markdown==3.7 +MarkupSafe==3.0.2 +mergedeep==1.3.4 +mkdocs==1.6.1 +mkdocs-get-deps==0.2.0 +mkdocs-material==9.5.44 +mkdocs-material-extensions==1.3.1 +packaging==24.2 +paginate==0.5.7 +pathspec==0.12.1 +platformdirs==4.3.6 +Pygments==2.18.0 +pymdown-extensions==10.12 +python-dateutil==2.9.0.post0 +PyYAML==6.0.2 +pyyaml_env_tag==0.1 +regex==2024.11.6 +requests==2.32.3 +six==1.16.0 +urllib3==2.2.3 +watchdog==6.0.0 From 729584d87f3ae25839b9303e7a90453f229c23a7 Mon Sep 17 00:00:00 2001 From: Jose Rodriguez Date: Sun, 17 Nov 2024 20:27:36 +0100 Subject: [PATCH 2/3] docs: update Tommy Gun link to forum Also try new syn highlight code in POINT --- docs/external_resources.md | 2 +- docs/library/point.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/external_resources.md b/docs/external_resources.md index 83a04ebae..83cd40d92 100644 --- a/docs/external_resources.md +++ b/docs/external_resources.md @@ -11,7 +11,7 @@ A free IDE created by [Tony Thompson](http://www.users.on.net/~tonyt73). This po generic 8-bit and 16-bit projects, and can be set up to be used with ZX Basic. Have a look at the [TommyGun files](https://sourceforge.net/projects/tommygun/files/) page. -To integrate ZX Basic with Tommy Gun, please follow this [tutorial](http://www.boriel.com/forum/viewtopic.php?f=14&t=329&start=0). +To integrate ZX Basic with Tommy Gun, please follow this [tutorial](https://www.boriel.com/forum/showthread.php?tid=110). ### SpectNet IDE A free and impressive IDE created by [Istvan Novak](https://github.com/Dotneteer). diff --git a/docs/library/point.md b/docs/library/point.md index 365e1d85f..001df7477 100644 --- a/docs/library/point.md +++ b/docs/library/point.md @@ -17,13 +17,13 @@ POINT is a library function to be included with the following command: ``` -# include +#include ``` ## Sample usage -```basic -# include +```bbcbasic +#include PLOT 10, 10 PRINT "Point at (10, 10) is "; POINT(10, 10): REM 1 From cc060aea35a567f555b835bd61c5034ea5e4954b Mon Sep 17 00:00:00 2001 From: Jose Rodriguez Date: Sun, 17 Nov 2024 20:48:12 +0100 Subject: [PATCH 3/3] feat: do not run test pipeline for docs/ branch This branch should only be used for documentation in directory docs/ --- .github/workflows/python-app.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index 266c227da..a31d101fb 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -5,9 +5,13 @@ name: ZXBasic on: push: - branches: [ main ] + branches: + - main pull_request: - branches: [ main ] + branches: + - main + branches-ignore: + - docs env: PYTHON_VERSION: 3.12.3