Docs

Adding flux weighting option to the effective_area function of Weighter objects #230

	# SPDX-FileCopyrightText: © 2022 the SimWeights contributors
	#
	# SPDX-License-Identifier: BSD-2-Clause

	name: Docs
	on:
	push:
	branches:
	- main
	pull_request:
	workflow_dispatch:
	jobs:
	Docs:
	runs-on: ubuntu-22.04
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"
	cache: pip
	cache-dependency-path: pyproject.toml
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install .[docs]
	- name: Run Sphinx
	working-directory: ./docs
	run: make html
	- name: Upload docs to docs.icecube.aq
	if: ${{ github.ref_name == 'main' && !github.event.act }}
	working-directory: ./docs
	run: \|
	tar -czvf simweights_docs.tar.gz -C_build/html .
	curl -XPUT -i --data-binary @simweights_docs.tar.gz https://docs.icecube.aq/api/upload?path=simweights/${{ github.ref_name }} -u icecube:${{ secrets.ICECUBE_PASSWORD }}
	# - name: Check Links
	# working-directory: ./docs
	# env:
	# ICECUBE_PASSWORD: ${{ secrets.ICECUBE_PASSWORD }}
	# run: make linkcheck SPHINXOPTS="-W --keep-going"

Provide feedback