Ⓜ️ Port site to mystmd (work in progress)

.circleci/config.yml

@@ -0,0 +1,51 @@
+version: 2.1
+
+jobs:
+  build-site:
+    docker:
+      - image: cimg/python:3.13
+    environment:
+      SITE_SRC: site
+      SITE_PATH: ${SITE_SRC}/_build/html
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - node-cache-v1
+
+      - run:
+          name: Install Node.js
+          command: |
+            curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
+            sudo apt-get install -y nodejs
+
+      - run:
+          name: Install mystmd
+          command: |
+            npm install mystmd
+
+      - save_cache:
+          key: node-cache-v1
+          paths:
+            - node_modules
+
+      - run:
+          name: Build site
+          command: |
+            export BASE_URL="/output/job/$CIRCLE_WORKFLOW_JOB_ID/artifacts/0/${SITE_PATH}"
+
+            (cd ${SITE_SRC} && npx myst build --html)
+
+            ## Temporary hack to remove unused thebe JS
+            rm ${SITE_PATH}/*thebe*.js
+
+      - store_artifacts:
+          path: ${SITE_PATH}
+
+workflows:
+  version: 2
+  build-and-site:
+    jobs:
+      - build-site

.github/workflows/circleci.yml

@@ -0,0 +1,22 @@
+name: circleci
+
+on: [status]
+permissions: read-all
+
+jobs:
+  circleci_artifacts_redirector_job:
+    runs-on: ubuntu-latest
+    if: "${{ github.event.context == 'ci/circleci: build-site' }}"
+    permissions:
+      statuses: write
+    name: Run CircleCI artifacts redirector
+    steps:
+      - name: GitHub Action step
+        uses: scientific-python/circleci-artifacts-redirector-action@839631420e45a08af893032e5a5e8843bf47e8ff
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          api-token: ${{ secrets.CIRCLECI_ARTIFACT_REDIRECTOR_TOKEN }}
+          artifact-path: 0/site/_build/html/index.html
+          circleci-jobs: build-site
+          job-title: "--> site preview <--"
+          domain: circle.scientific-python.dev

.gitignore

@@ -142,9 +142,6 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
-/site
-
 # mypy
 .mypy_cache/
 .dmypy.json
@@ -165,3 +162,12 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# MyST build outputs
+_build
+
+# Vim swap files
+*.swp
+
+# Javascript envieonment
+node_modules

.pre-commit-config.yaml

@@ -25,22 +25,6 @@ repos:
         files: \.(css|md|yml|yaml)
         args: [--prose-wrap=preserve]
 
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: fe95161893684893d68b1225356702ca71f8d388 # frozen: 25.9.0
-    hooks:
-      - id: black
-
-  - repo: https://github.com/asottile/blacken-docs
-    rev: dda8db18cfc68df532abf33b185ecd12d5b7b326 # frozen: 1.20.0
-    hooks:
-      - id: blacken-docs
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: 37bfa06d791fd38fb4e54910b36a2ff57641b074 # frozen: v3.20.0
-    hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
-
   - repo: https://github.com/codespell-project/codespell
     rev: "63c8f8312b7559622c0d82815639671ae42132ac" # frozen: v2.4.1
     hooks:

Makefile

@@ -1,46 +1,26 @@
-.PHONY: help themes html serve clean
+.PHONY: help html serve clean
 .DEFAULT_GOAL := help
 
 help:
 	@grep ": ##" Makefile | grep -v grep | tr -d '#'
 
-themes/scientific-python-hugo-theme:
-	@if [ ! -d "$<" ]; then \
-	  echo "*** ERROR: missing theme" ; \
-	  echo ; \
-	  echo "It looks as though you are missing the themes directory."; \
-	  echo "You need to add the scientific-python-hugo-theme as a submodule."; \
-	  echo ; \
-	  echo "Please see https://theme.scientific-python.org/user_guide/getstarted/"; \
-	  echo ; \
-	  exit 1; \
-	fi
+team.md:
+	team_query.py --org scientific-python --team "tools-team"  >  team.md
 
-themes: themes/scientific-python-hugo-theme
+team-clean:
+	rm -f team.md
 
-TEAMS_DIR = content/about
-TEAMS = tools-team
-TEAMS_QUERY = python themes/scientific-python-hugo-theme/tools/team_query.py
+team: ## generates team gallery
+team: | team-clean team.md
 
-$(TEAMS_DIR)/%.toml:
-	$(TEAMS_QUERY) --org scientific-python --team "$*"  >  $(TEAMS_DIR)/$*.toml
+html: ## Build site in `./site/_build`
+html:
+	(cd site; myst build --html;)
 
-teams-clean:
-	for team in $(TEAMS); do \
-	  rm -f $(TEAMS_DIR)/$${team}.toml ;\
-	done
-
-teams: ## generates team gallery pages
-teams: | teams-clean $(patsubst %,$(TEAMS_DIR)/%.toml,$(TEAMS))
-
-html: ## Build site in `./public`
-html: themes
-	hugo
-
-serve: ## Serve site, typically on http://localhost:1313
-serve: themes
-	@hugo --printI18nWarnings server
+serve: ## Serve site, typically on http://localhost:3000
+serve:
+	(cd site; myst start;)
 
 clean: ## Remove built files
 clean:
-	rm -rf public
+	rm -rf site/_build

README.md

@@ -1 +1,12 @@
 # tools.scientific-python.org
+
+This repository hosts the source code for the website https://tools.scientific-python.org.
+
+The site is implemented with the mystmd book template.
+
+To run locally:
+
+```
+cd site
+myst start
+```