add references #63
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow uses actions that are not certified by GitHub. | |
| # They are provided by a third-party and are governed by | |
| # separate terms of service, privacy policy, and support | |
| # documentation. | |
| # Sample workflow for building and deploying a Jekyll site to GitHub Pages | |
| name: Deploy Jekyll site to Pages | |
| on: | |
| push: | |
| branches: ["main", "doc"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: '3.3' # Not needed with a .ruby-version file | |
| bundler-cache: true # runs 'bundle install' and caches installed gems automatically | |
| cache-version: 0 # Increment this number if you need to re-download cached gems | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: API Doc | |
| run: | | |
| pip install pydoctor | |
| pydoctor --project-name=Spatialyze \ | |
| --project-version=0.1.0 \ | |
| --project-url=https://apperception-db.github.io/spatialyze \ | |
| --html-viewsource-base=https://github.com/apperception-db/spatialyze/tree/main \ | |
| --make-html \ | |
| --html-output=docs/api \ | |
| --project-base-dir="." \ | |
| --docformat=epytext \ | |
| --intersphinx=https://docs.python.org/3/objects.inv \ | |
| --privacy="HIDDEN:spatialyze.video_processor.modules" \ | |
| --privacy="HIDDEN:spatialyze.video_processor.stages" \ | |
| ./spatialyze || true | |
| - name: Copy Assets | |
| run: | | |
| mkdir -p docs/data | |
| cp -r data/assets docs/data | |
| - name: Build with Jekyll | |
| if: always() | |
| # Outputs to the './_site' directory by default | |
| working-directory: ./docs | |
| run: | | |
| cat ../README.md >> index.md | |
| gem install bundler jekyll | |
| bundle install | |
| bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | |
| cp -r _site ../_site | |
| env: | |
| JEKYLL_ENV: production | |
| - name: Upload artifact | |
| if: always() | |
| # Automatically uploads an artifact from the './_site' directory by default | |
| uses: actions/upload-pages-artifact@v3 | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |