diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 1b37e69..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,46 +0,0 @@ -# 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 - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - path: "./_build/html" - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v2 diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..e0f9bb6 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# Configuration on how ReadTheDocs (RTD) builds our documentation +# ref: https://readthedocs.org/projects/frx-challenges/ +# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html +# +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + nodejs: "18" + commands: + - mkdir $READTHEDOCS_OUTPUT + - cd docs + - pip install -r requirements.txt + - myst build --html --ci --check-links + - cp --recursive _build/* $READTHEDOCS_OUTPUT/ + +# Explicitly opt out of trying to build additional formats such as PDF and ePub +formats: []