Skip to content

Commit

Permalink
Add execution to our documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Apr 17, 2024
1 parent a200549 commit 22e22bf
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# This should disallow all search index crawling of the documentation.
# we are using RTD *only* for PR previews, and not for hosting the actual docs.
# So this should be added to the HTML output within readthedocs.
User-agent: *
Disallow: /
Empty file added .github/workflows/docs.yml
Empty file.
6 changes: 5 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ReadTheDocs configuration structure
# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2
build:
os: ubuntu-lts-latest
Expand All @@ -8,9 +10,11 @@ build:
- npm run build
- npm run --workspace packages/mystmd link
- myst --version
- cd docs && BASE_URL=${READTHEDOCS_CANONICAL_URL} myst build --html
- cd docs && BASE_URL=${READTHEDOCS_CANONICAL_URL} myst build --html --execute
# TODO: Switch to rsync
# https://github.com/readthedocs/readthedocs.org/issues/11219
# - /usr/bin/rsync -a --mkpath docs/_build/ $READTHEDOCS_OUTPUT/
- mkdir -p $READTHEDOCS_OUTPUT
- cp -a docs/_build/* $READTHEDOCS_OUTPUT/
# Copy robots.txt to avoid search indexing
- cp .github/robots.txt $READTHEDOCS_OUTPUT/robots.txt
2 changes: 2 additions & 0 deletions docs/execute-notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,5 @@ By default MyST caches the execution of a notebook according to its executable c
```bash
myst clean --execute
```

{eval}`2 + 2

0 comments on commit 22e22bf

Please sign in to comment.