ci: add GH pages

.github/workflows/deploy.yml

@@ -0,0 +1,47 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines the website is served from, including CSS & JS assets
+  # You may need to change this to `BASE_URL: ''`
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install MyST Markdown
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+        working-directory: ./docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './docs/_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

docs/.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+/_build/

docs/include-sphinx.md

@@ -0,0 +1,46 @@
+---
+title: Include Sphinx Projects in MyST
+subtitle: Gradually Upgrade Sphinx-based Projects to MyST 
+short_title: Include in MyST
+description: Gradually upgrade Sphinx projects to the MyST engine through the MyST build engine
+---
+
+## Configure Your Project
+
+The Sphinx `conf.py` for your project should include `sphinx-ext-mystmd`. If your Sphinx project lives under `sphinx`, then your `conf.py` might look like.
+:::{code} python
+:filename: conf.py
+
+extensions = [
+    "sphinx_ext_mystmd"
+]
+:::
+
+## Build the Sphinx Project
+
+```shell
+sphinx-build -b myst sphinx mdast
+```
+
+## Configure the MyST Project
+
+:::{code} yaml
+:filename: myst.yml
+
+version: 1
+project:
+  toc:
+    - file: index.md
+    - pattern: mdast/content/*.json
+site:
+  template: book-theme
+:::
+
+## Build the MyST Project
+```shell
+myst start
+```
+
+
+
+

docs/index.md

@@ -0,0 +1,9 @@
+# `sphinx-ext-mystd`
+
+::::{important} Purpose
+
+The goal of this extension is to support gradual upgrade of Sphinx-based documentation projects into MyST-enabled workflows.
+
+This extension can add `xref` support to existing Sphinx sites, and generate JSON files for building in MyST.
+::::
+

docs/myst.yml

@@ -0,0 +1,15 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 8e7a53c3-4111-453c-8a9c-e8b294af4052
+  # title:
+  # description:
+  # keywords: []
+  # authors: []
+  github: https://github.com/executablebooks/sphinx-ext-mystmd
+  # To autogenerate a Table of Contents, run "myst init --write-toc"
+site:
+  template: book-theme
+  # options:
+  #   favicon: favicon.ico
+  #   logo: site_logo.png