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
7 changes: 7 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ sphinx:
- fmt: py
# A tutorial or demo that raises fails the build, instead of a warning
nb_execution_raise_on_error: true
# Pages that cite references cited elsewhere too list them as footnotes,
# {footcite} and {footbibliography}. MyST checks footnotes before
# sphinxcontrib-bibtex creates them, and warns about each; the book has
# no MyST footnotes of its own
suppress_warnings: ["myst.footnote"]
# No rule before the footnotes, which end a page under References
myst_footnote_transition: false
autodoc_member_order: bysource
# The page tables of contents list objects by name, without their module
toc_object_entries_show_parents: hide
Expand Down
3 changes: 3 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ parts:
- caption: "Electrochemistry"
chapters:
- file: "examples/electrochemistry/porous_electrode.py"
- file: "examples/electrochemistry/vanadium_half_cell_1d.py"
- file: "examples/electrochemistry/vanadium_half_cell_2d.py"
- file: "examples/electrochemistry/vanadium_half_cell_3d.py"
- caption: "Python API"
chapters:
- file: "docs/api/index"
Expand Down
7 changes: 7 additions & 0 deletions docs/api/electrochemistry.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,10 @@
.. autoclass:: MassTransferButlerVolmer
:members:
```

## Half-cells

```{eval-rst}
.. autoclass:: RedoxHalfCell
:members:
```
14 changes: 14 additions & 0 deletions docs/api/symbolic.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
:members:

.. autofunction:: as_expr

.. autofunction:: value_at_defaults
```

## Components
Expand Down Expand Up @@ -121,7 +123,11 @@
.. autoclass:: Interpolation
:members:

.. currentmodule:: sumfem.symbolic.transfer

.. autodata:: Transferable

.. currentmodule:: sumfem.symbolic
```

## Units and dimensional analysis
Expand All @@ -140,12 +146,20 @@

.. autoexception:: UnitError

.. currentmodule:: sumfem.symbolic.constants

.. autodata:: BOLTZMANN

.. currentmodule:: sumfem.symbolic.constants

.. autodata:: FARADAY

.. currentmodule:: sumfem.symbolic.constants

.. autodata:: GAS_CONSTANT

.. currentmodule:: sumfem.symbolic

.. autofunction:: boltzmann_constant
```

Expand Down
Loading
Loading