docs: add usage examples and introduction (#38) #159

	name: legend-geom-optics

	on:
	push:
	branches:
	- main
	- 'releases/**'
	pull_request:
	release:

	jobs:

	build-and-test:
	name: Test legendoptics with Python
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	python-version: ['3.9', '3.10', '3.11']
	os: [ubuntu-latest, macOS-latest]

	steps:
	- uses: actions/checkout@v3
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v3
	with:
	python-version: ${{ matrix.python-version }}
	- name: Get dependencies and install the legendoptics
	run: \|
	python -m pip install --upgrade pip wheel setuptools
	python -m pip install --upgrade .[test]
	- name: Run unit tests
	run: \|
	pytest

	test-coverage:
	name: Calculate and upload test coverage
	needs: build-and-test
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	with:
	fetch-depth: 2
	- uses: actions/setup-python@v3
	with:
	python-version: '3.10'

	- name: Generate Report
	run: \|
	python -m pip install --upgrade pip wheel setuptools
	python -m pip install --upgrade .[test]
	pytest --cov=legendoptics --cov-report=xml
	- name: Upload Coverage to codecov.io
	uses: codecov/codecov-action@v3

	build-docs:
	name: Build documentation
	needs: build-and-test
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	with:
	fetch-depth: 0
	- uses: actions/setup-python@v3
	with:
	python-version: '3.10'
	- name: Setup build environment
	run: \|
	python -m pip install --upgrade pip wheel setuptools
	python -m pip install --upgrade .[docs]
	- name: Build docs for current ref
	run: \|
	cd docs
	make clean
	make

Provide feedback