Merge pull request #896 from boriel-basic/docs

Docs

Author: boriel

.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

.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

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).

docs/library/point.md

@@ -17,13 +17,13 @@ POINT is a library function to be included with the following command:
 
 
 ```
-# include <point.bas>
+#include <point.bas>
 ```
 
 ## Sample usage
 
-```basic
-# include <point.bas>
+```bbcbasic
+#include <point.bas>
 
 PLOT 10, 10
 PRINT "Point at (10, 10) is "; POINT(10, 10): REM 1

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

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