Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,17 @@ jobs:

- name: Build documentation
shell: bash
# I have to 'cd' because interlinks does not allow to pass a different path
# 1. I have to 'cd' because interlinks does not allow to pass a different path
# 2. sphobjinv and mv are needed to offer objects.inv to other projects
run: |
cd docs
pixi run -e dev python -m quartodoc build
pixi run -e dev python -m quartodoc build --verbose
pixi run -e dev python -m quartodoc interlinks
quarto render
touch _site/.nojekyll
pixi run -e dev python -m sphobjinv convert -o zlib objects.txt objects.inv
mv objects.inv _site/objects.inv
ls _site
- name: Publish documentation to GitHub
if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags')
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ _site
api/*
**/*.quarto_ipynb
objects.json
objects.txt
objects.inv
1 change: 1 addition & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ filters:

# The objects in all cases are in `objects.inv` at the listed URLs
interlinks:
fast: true # Creates .txt inventory that we then convert
sources:
python:
url: https://docs.python.org/3/
Expand Down