docs

Add documentation to ush/HWP_tools.py (#515) #65

	# This workflow will build the documentation.
	#
	# Edward Hartnett, 9/16/24

	name: docs

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]

	permissions:
	contents: read

	jobs:
	docs:

	runs-on: ubuntu-latest

	steps:
	- name: checkout
	uses: actions/checkout@v4
	with:
	path: rrfs-workflow
	submodules: true

	- name: Set up Python 3.10
	uses: actions/setup-python@v5
	with:
	python-version: "3.10"
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme
	- name: Build docs
	run: \|
	cd rrfs-workflow/docs
	#sphinx-build -W --keep-going source build
	sphinx-build source build
	- uses: actions/upload-artifact@v4
	with:
	name: rrfs-workflow docs
	path: \|
	rrfs-workflow/docs/build

Provide feedback