Skip to content

DOC: Use a subsection in API docs per dataset #48

DOC: Use a subsection in API docs per dataset

DOC: Use a subsection in API docs per dataset #48

Workflow file for this run

# Docs workflow
#
# Ensures that the docs can be built with sphinx.
# - On every push and PR, checks the HTML documentation builds on linux.
# - On every PR and tag, checks the documentation builds as a PDF on linux.
# - If your repository is public, on pushes to the default branch (i.e. either
# master or main), the HTML documentation is pushed to the gh-pages branch,
# which is automatically rendered at the publicly accessible url
# https://USER.github.io/PACKAGE/
name: docs
on: [push, pull_request]
jobs:
docs-html:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check if README.md needs to be converted
id: check_readme
run: |
if [ ! -f "README.rst" ] && [ -f "README.md" ]; then
echo "convert=true" >> $GITHUB_OUTPUT
fi
- name: Convert README.md to README.rst
if: steps.check_readme.outputs.convert == 'true'
uses: docker://pandoc/core:2.9
with:
args: >-
README.md
--from=gfm
--output=README.rst
- name: Build HTML docs
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"