Shift BeeWare tutorial to MkDocs (#3)

Author: kattni

.github/workflows/pre-commit-update.yml

@@ -0,0 +1,15 @@
+name: Update pre-commit
+
+on:
+  schedule:
+    - cron: "0 20 * * SUN"  # Sunday @ 2000 UTC
+  workflow_dispatch:
+
+jobs:
+  pre-commit-update:
+    name: Update pre-commit
+    uses: beeware/.github/.github/workflows/pre-commit-update.yml@main
+    secrets: inherit
+    with:
+      pre-commit-source: pre-commit
+      create-changenote: false

.gitignore

@@ -1,3 +1,11 @@
+# MkDocs
+_build
+comment.md
+
+# Translations
+*.mo
+*.pot
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -45,10 +53,6 @@ coverage.xml
 *,cover
 .hypothesis/
 
-# Translations
-*.mo
-*.pot
-
 # Django stuff:
 *.log
 local_settings.py

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: check-case-conflict
+      - id: end-of-file-fixer
+        # PO files may not have a trailing EOL, as they are tool generated
+        exclude: "locales"
+      - id: trailing-whitespace

.pyspelling.yml

@@ -0,0 +1,43 @@
+matrix:
+- name: markdown
+  dictionary:
+    wordlists:
+    - docs/spelling_wordlist
+    output: _build/dictionary/python.dic
+  sources:
+  - '**/*.md'
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.toc
+      - markdown.extensions.admonition
+      - markdown.extensions.attr_list
+      - pymdownx.superfences
+      - pymdownx.blocks.admonition
+      - pymdownx.blocks.caption
+      - pymdownx.blocks.tab
+  - pyspelling.filters.html:
+      comments: true
+      attributes:
+        - title
+        - alt
+      ignores:
+        - 'code'
+        - 'pre'
+        - 'nospell'
+  - pyspelling.filters.context:
+      context_visible_first: true
+      escapes: '\\[\\`~]'
+      delimiters:
+        # Ignore the Jinja directives
+        - open: '{%'
+          content: '[\d\D]*'
+          close: '%}'
+        # Ignore the single line Snippets syntax
+        - open: '-8<\-'
+          content: '[\d\D]*'
+          close: '\n'
+        # Ignore the multiline Snippets syntax
+        - open: '-8<\-\n'
+          content: '[\d\D]*'
+          close: '-8<-\n'

.readthedocs.yaml

@@ -7,26 +7,15 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    # Docs are always built on Python 3.12. See also the tox config.
-    python: "3.12"
+    # Docs are always built on Python 3.13. See also the tox config.
+    python: "3.13"
   jobs:
+    pre_install:
+      - python -m pip install -r requirements.dev.txt
     pre_build:
-      - pip install -r requirements.dev.txt
-      - tox -e docs-lint
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  builder: html
-  configuration: docs/conf.py
-  fail_on_warning: true
-
-# Build docs as PDF (other options are epub and htmlzip)
-formats:
-   - pdf
-
-# Optionally declare the Python requirements required to build your docs
-python:
-  install:
-  - requirements: requirements.docs.txt
+      - python -m tox -e docs-lint
+    build:
+      html:
+        - python -m tox -e docs-$READTHEDOCS_LANGUAGE -- --output=$READTHEDOCS_OUTPUT/html/

README.md

@@ -28,10 +28,10 @@ Community Code of Conduct](http://beeware.org/community/behavior/).
 
 ## Contributing
 
-If you experience problems with BeeWare, [log them on
-GitHub](https://github.com/beeware/beeware/issues). If you want to contribute
-code, please [fork the code](https://github.com/beeware/beeware) and [submit a
-pull request](https://github.com/beeware/beeware/pulls).
+If you experience problems with the BeeWare Tutorial, [log them on
+GitHub](https://github.com/beeware/beeware-tutorial/issues). If you want to contribute
+code, please [fork the code](https://github.com/beeware/beeware-tutorial) and [submit a
+pull request](https://github.com/beeware/beeware-tutorial/pulls).
 
 ### Translations