Skip to content

Commit

Permalink
Merge pull request #448 from pyiron/docs
Browse files Browse the repository at this point in the history
Add Docs workflow
  • Loading branch information
niklassiemer committed Jul 8, 2022
2 parents c79b573 + 3a62f6b commit d166c08
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# This workflow is used to test, if the documentation can build

name: Docs

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: conda-incubator/setup-miniconda@v2
with:
python-version: "3.10"
mamba-version: "*"
channels: conda-forge
channel-priority: strict
auto-update-conda: true
environment-file: .ci_support/environment.yml
- name: Setup
shell: bash -l {0}
run: |
python .ci_support/pyironconfig.py
pip install --no-deps .
conda env update --name test --file docs/environment.yml
- name: Documentation
shell: bash -l {0}
run: |
mkdir public_html; cd docs
sphinx-build -b html ./ ../public_html || exit 1;
cd ..
9 changes: 5 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@
# Required
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "mambaforge-4.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats: []

# Install pyiron from conda
conda:
environment: docs/environment.yml

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- method: pip
path: .

0 comments on commit d166c08

Please sign in to comment.