Skip to content

Commit acac752

Browse files
committed
Small fixes to readme and build job name
1 parent 4d62c9b commit acac752

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

.github/workflows/build_docs.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
# This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
2-
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3-
4-
name: Jupyter Book (via myst) GitHub Pages Deploy plus PyTest Cov
1+
name: Documentation
52
on:
63
push:
74
# Runs on pushes targeting the default branch
@@ -228,14 +225,15 @@ jobs:
228225
with:
229226
name: book
230227
path: './docs/_build/html'
231-
228+
# Deploy job
232229
deploy_book:
233230
needs: build_book
234231
environment:
235232
name: github-pages
236233
url: ${{ steps.deployment.outputs.page_url }}
237234
runs-on: ubuntu-latest
238-
if: github.ref == 'refs/heads/main' && github.event_name == 'push' # Only run on main when pushed
235+
# Only run on main when pushed, we don't want to publish docs for an unmerged PR
236+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
239237
steps:
240238
- name: Make Directory
241239
run: mkdir -p ./docs/_build/html

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Structural Dynamics Python Libraries
33
####################################
44

5-
|documentation| |build| |codecov| |coveralls| |codefactor| |pylint| |docker|
5+
|documentation| |build| |codecov| |coveralls| |pylint| |docker|
66

77
This repository houses SDynPy, a Python module built for doing structural dynamics analysis using Python.
88
It contains core objects that define test geometry and data. It contains readers and writers for common data formats.

0 commit comments

Comments
 (0)