Skip to content

Add Long-form API documentation #18

Add Long-form API documentation

Add Long-form API documentation #18

Workflow file for this run

# workflow to build and deploy FORD docs for FTorch
name: BuildDocs
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main", "API-docs" ]
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Workflow run - one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build-docs"
build-docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout code
uses: actions/checkout@v3
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ford
- name: Build docs with FORD
run: ford FTorch.md
- name: Test docs build
if: github.ref != 'refs/heads/main'
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: docs-test # The branch the action should deploy to.
folder: doc # The folder the action should deploy.
dry-run: true # Don't actually push to pages, just test if we can
- name: Deploy Documentation for master
# if: github.ref == 'refs/heads/main'
if: github.ref == 'refs/heads/API-docs'
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages # The branch the action should deploy to.
folder: doc # The folder the action should deploy.