Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation about pybamm-cookiecutter #5

Open
1 of 5 tasks
agriyakhetarpal opened this issue Aug 4, 2023 · 0 comments
Open
1 of 5 tasks

Documentation about pybamm-cookiecutter #5

agriyakhetarpal opened this issue Aug 4, 2023 · 0 comments

Comments

@agriyakhetarpal
Copy link
Member

agriyakhetarpal commented Aug 4, 2023

A placeholder issue for keeping track of documentation-related tasks.

  • Set up an initial draft for documentation pages for the project: installation, technical details, user guide, adding data paths, adding parameter sets, and more
  • Surrounding infrastructure for building the documentation locally (tracked by Add templates and configuration for documentation #4)
  • In the project's documentation: a basic guide to using Sphinx, adding example notebooks and scripts, adding thumbnail galleries, adding a references page, troubleshooting, and FAQs.
    • Possibly, some utility functions for registering citations in both code and documentation, similar to PyBaMM's citation workflow
  • Surrounding infrastructure for deploying the documentation on Read the Docs in the CI. It should have PR builds on each commit, cancelling the build on subsequent pushes to a branch

See also: #1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant