Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor auto-generate aeon_acquisition docs #49

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
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
13 changes: 0 additions & 13 deletions .config/dotnet-tools.json

This file was deleted.

47 changes: 10 additions & 37 deletions .github/workflows/docs_build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,54 +18,27 @@ jobs:
build_sphinx_docs:
name: Build Sphinx Docs
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@v4
with:
submodules: true # Enable automatic checkout of all submodules

- name: Setup .NET
uses: actions/setup-dotnet@v4
- name: Set up conda
uses: conda-incubator/setup-miniconda@v3
with:
dotnet-version: 8.x

- name: Setup DocFX
run: dotnet tool restore

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.11

- name: Upgrade pip
shell: bash
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip

- name: Get pip cache dir
shell: bash
id: pip-cache
run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT

- name: Cache dependencies
uses: actions/cache@v4
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- name: Install dependencies
shell: bash
run: python3 -m pip install -r ./requirements.txt

auto-update-conda: true
channels: conda-forge, nodefaults
activate-environment: aeon_docs
environment-file: environment.yml

- name: Check external links
shell: bash
run: make linkcheck

# needs to have sphinx.ext.githubpages in conf.py extensions list
- name: Building documentation
shell: bash
run: make html

- name: Upload the content for deployment
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
docs/
src/reference/api/
src/user/**/*_copy*
src/xml/

# Python scripts
__pycache__
Loading
Loading