flub in github action commnand

philzook58 · May 29, 2024 · 6c5c63f · 6c5c63f
1 parent ce45f2b
commit 6c5c63f
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -16,7 +16,7 @@ jobs:
           pip install sphinx sphinx_rtd_theme myst_parser
       - name: Sphinx build
         run: |
-          sphinx-build doc _build
+          sphinx-build docs _build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 __pycache__
 dist
 build
+_build/
diff --git a/README.md b/README.md
@@ -19,6 +19,9 @@ python3 -m pip install -e .
 ## Blog Posts
 
 - [Knuckledragger: Experimenting with a Python Proof Assistant](https://www.philipzucker.com/python-itp/)
+- [Experiments in the Irrationality of Sqrt 2 with SMT](https://www.philipzucker.com/sqrt2/)
+- [Peano Nats in Interactive SMT](https://www.philipzucker.com/sqrt2_2/)
+- [Proving Sum n = n*(n-1)/2 and that 1/n tends to 0](https://www.philipzucker.com/analysis_knuckle/)
 
 ## Design
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -24,6 +24,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
+    "myst_parser",
 ]
 autosummary_generate = True
 
@@ -46,6 +47,11 @@
 napoleon_type_aliases = None
 napoleon_attr_annotations = True
 
+# Optional: Set the file suffixes that MyST will handle
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,8 @@
 Welcome to knuckledragger's documentation!
 ==========================================
 
+.. include:: ../README.md
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: