[PyBaMM] - Documentation - Agriya Khetarpal
- Mentors
- Saransh Chopra, Valentin Sulzer
- Organization
- NumFOCUS
- Technologies
- python, html, sphinx, css, GitHub Actions
- Topics
- web, documentation, CI/CD
This project aims to enhance the documentation infrastructure for PyBaMM and consolidate all of it in one place, which includes but will not be limited to: the API documentation, user guides, the example Jupyter notebooks, and the PyBaMM Wiki. This project will also introduce a new pybamm.org website with the Hugo static site generator, and improvements to the existing documentation built with Sphinx – based on other popular Python packages and libraries in order to make it more robust and maintainable. The project will also include other infrastructure improvements in scope such as those for the test suites, installation, and creating releases.