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

Partial fix of quartodoc CI rendering #134

Merged
merged 5 commits into from
Feb 26, 2024
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
19 changes: 16 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ env:
COMPOSE_DOCKER_CLI_BUILD: 1
CONDA_ENV_NAME: clim-recal
CONDA_ENV_PATH: environment.yml
MIN_PYTHON_VERSION: 3.9
MIN_PYTHON_VERSION: "3.10"
PYTHON_MODULE_FOLDER: python/
COVERAGE_SVG_FOLDER: docs/assets/
COVERAGE_SVG_FILE_NAME: coverage.svg
Expand All @@ -16,11 +16,11 @@ env:

on:
pull_request:
branches: ['main', 'r-docker-refactor']
branches: ['main', 'fix-quartodoc']
paths-ignore: ['docs/**']

push:
branches: ['main', 'r-docker-refactor']
branches: ['main', 'fix-quartodoc']

concurrency:
group: ${{ github.head_ref || github.run_id }}
Expand Down Expand Up @@ -89,3 +89,16 @@ jobs:
with:
name: coverage-badge
path: ${{ env.GH_PAGE_PATH }}${{ env.COVERAGE_SVG_PATH }}

- name: Build Conda Environment
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: ${{ env.CONDA_ENV_NAME }}
environment-file: ${{ env.CONDA_ENV_PATH }}
auto-activate-base: false
miniforge-version: latest

- name: Run `quartodoc`
shell: bash -el {0}
run: |
mamba run -n ${{ env.CONDA_ENV_NAME }} quartodoc build
32 changes: 17 additions & 15 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,16 @@ website:
- "python/README.md"
- section: "Reference"
contents:
- href: "docs/reference/data_download.ceda_ftp_download.download_ftp.qmd"
- href: "docs/reference/ceda_ftp_download.download_ftp.qmd"
text: "Download CEDA FTP"
# - href: "docs/reference/utils.qmd"
# text: "Utilities"
# There are errors rendering the pages below
# see: https://github.com/alan-turing-institute/clim-recal/issues/128
# - href: "docs/reference/resampling.qmd"
# text: "HADs Resampling"
# - href: "docs/reference/debiasing.qmd"
# text: "Debiasing"
- href: "docs/reference/utils.qmd"
text: "Utilities"
- text: "Docker"
href: "docs/docker-configurations.qmd"

Expand All @@ -83,16 +83,18 @@ quartodoc:
# write sidebar data to this file
sidebar: _sidebar.yml
source_dir: ./python/
#
# see: https://github.com/alan-turing-institute/clim-recal/issues/128
# sections:
# - title: Data Source Management
# desc: How data is downloaded for use
# contents:
# # the functions being documented in the package.
# # you can refer to anything: class methods, modules, etc..
# - data_download
# # - load_data
# # - resampling
# # - debiasing
# - utils
sections:
- title: Data Source Management
desc: How data is downloaded for use
contents:
# the functions being documented in the package.
# you can refer to anything: class methods, modules, etc..
- data_download
# - load_data
# - resampling
# - debiasing
# - title: Utilities
# desc: Manage data and workshops
# contents:
# - utils
Loading