Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Deploy documentation

on:
push:
branches:
- develop
- master
- main
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install documentation dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e . -r docs/requirements.txt

- name: Build site
run: zensical build --clean

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

*.bak

docs/build
docs/pycalfem
site/

venv-calfem

Expand Down Expand Up @@ -38,8 +38,6 @@ examples/.ipynb_checkpoints/*
calfem/.ipynb_checkpoints/*
exm6.vtk

# new notebook examples
docs/source/examples/.ipynb_checkpoints/
.DS_Store
*.lock
*.log
Expand Down
3 changes: 3 additions & 0 deletions docs/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"iis.configDir": ""
}
216 changes: 0 additions & 216 deletions docs/Makefile

This file was deleted.

33 changes: 33 additions & 0 deletions docs/docs/calfem_reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Function reference

The [CALFEM manual](https://calfem-python-manual.readthedocs.io/en/latest/)
is the primary source for conceptual descriptions of the standard
function groups:
[material](https://calfem-python-manual.readthedocs.io/en/latest/material_functions.html),
[element](https://calfem-python-manual.readthedocs.io/en/latest/element_functions.html),
[system](https://calfem-python-manual.readthedocs.io/en/latest/system_functions.html),
[graphics](https://calfem-python-manual.readthedocs.io/en/latest/graphics_functions.html),
[utility](https://calfem-python-manual.readthedocs.io/en/latest/utility_functions.html),
and [matrix](https://calfem-python-manual.readthedocs.io/en/latest/matrix_functions.html)
functions. This page is the generated Python API reference for the
installed package.

## Core functions

::: calfem.core

## Geometry functions

::: calfem.geometry

## Mesh functions

::: calfem.mesh

## Utility functions

::: calfem.utils

## Visualisation functions (Matplotlib)

::: calfem.vis_mpl
Loading
Loading