Skip to content

Commit

Permalink
Fix failing doctests (#57)
Browse files Browse the repository at this point in the history
Fixed doctests and added pybamm-cookie and PyPI badges to readme.

Fixes #56
  • Loading branch information
santacodes authored Aug 28, 2024
1 parent 34652d3 commit 9f9f180
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 12 additions & 2 deletions .github/workflows/test_on_push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ jobs:

- name: Set up Git
run: |
git config --global user.name "pybamm user"
git config --global user.email "pybammuser@pybamm.org"
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Test template generation
run: nox -s template-tests
Expand Down Expand Up @@ -97,6 +97,11 @@ jobs:
- name: Install nox
run: uv pip install nox[uv]

- name: Set up Git
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Check if the documentation can be built
run: nox -s docs

Expand Down Expand Up @@ -169,6 +174,11 @@ jobs:
uv pip install copier jinja2-time
copier copy . . --trust --defaults
- name: Set up Git
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Check if the documentation can be built
working-directory: ./pybamm-example-project
run: |
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
<!-- SPHINX-START -->
[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](http://numfocus.org)
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-red.json)](https://github.com/copier-org/copier)
[![pybamm-cookie](https://img.shields.io/badge/%F0%9F%8D%AA%20pybamm--cookie-cf4c4c?style=flat&link=https%3A%2F%2Fgithub.com%2Fpybamm-team%2Fpybamm-cookie)](https://github.com/pybamm-team/pybamm-cookie)
[![PyPI](https://img.shields.io/badge/PyPI-white?style=flat&logo=pypi&link=https%3A%2F%2Fpypi.org%2Fproject%2Fpybamm-cookie%2F)](https://pypi.org/project/pybamm-cookie/)
[![Test template and generated project](https://github.com/pybamm-team/pybamm-cookie/actions/workflows/test_on_push.yml/badge.svg)](https://github.com/pybamm-team/pybamm-cookie/actions/workflows/test_on_push.yml)

This repository contains a `copier` template for battery modeling projects using PyBaMM, released under the [BSD-3-Clause license](https://github.com/pybamm-team/pybamm-cookie/blob/main/LICENSE). Currently under active development.
Expand Down

0 comments on commit 9f9f180

Please sign in to comment.