Comments (1)
How to update Sphinx docs
If file structure hasn't changed, we don't need to do anything.
If file structure has changed, first update tables of content
cd docs
sphinx-apidoc -o source ../pybamm
Then build html
make html
We could also make any stylistic changes in docs/conf.py
, then build html
from pybamm.
Related Issues (20)
- Rename `set_events` HOT 4
- Allow `QuickPlot.plot` to take a list of times
- Add example of lithium plating for composite electrodes
- Clarify definition of PyBaMM's SPMe HOT 2
- [Bug]: Tests failing for Python 3.12 HOT 1
- Add solvent consumption model into PyBaMM HOT 1
- Pipelining parameter sweeping for long-term degradation modelling HOT 1
- [Bug]: the corrector convergence failed repeatedly or with |h| = hmin. HOT 9
- [Bug]: TypeError in Example Notebook: Simulation.__init__() got an unexpected keyword argument 'discretisation_kwargs' HOT 2
- [Bug]: Bug with the calculation of PE porosity in porosity sub-model HOT 2
- How to install JellyBamm package HOT 1
- Pybtex warnings on downstream projects HOT 2
- Time stepping in IDA - minimise solver restarts HOT 2
- [Bug]: unnecessary copying for IDAKLU solver Expression class get_row() / get_col()
- [Bug]: Half cell negative reaction heating set to 0
- [Bug]: hysteresis state error HOT 24
- Extend `pybamm.ParameterValues.create_from_bpx()` to automate initial concentrations for blended electrodes HOT 4
- [Bug]: Spurious key 'check_already_exists' added to output of `pybamm.ParameterValues.create_from_bpx` HOT 1
- Possible to split optional and required dependencies on conda HOT 1
- [Bug]: Use of lead-acid battery models HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pybamm.