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

Minor issues for 0.2.0 #28

Closed
19 tasks done
ischoegl opened this issue Dec 3, 2020 · 3 comments · Fixed by #66
Closed
19 tasks done

Minor issues for 0.2.0 #28

ischoegl opened this issue Dec 3, 2020 · 3 comments · Fixed by #66
Assignees
Milestone

Comments

@ischoegl
Copy link
Collaborator

ischoegl commented Dec 3, 2020

This is a running list of minor issues that should be taken care of:

Some remaining edits of Sphinx documentation

  • Move jupyter notebooks into a dedicated docs/examples folder (from current docs/pages) (@ischoegl ... see Add tests for custom simulation modules #45)
  • Add descriptions of how to run batch jobs from commandline to overview.rst, ignition.rst and adiabatic_flame.rst (see README.rst)
  • Check and fix broken links in Sphinx documentation (e.g. several links in README.rst)
  • Add instructions for conda environment to INSTALL.rst - see e.g. camsym
  • Update docstrings of SimulationHandler ... make description more generic (not tied to minimal example)
@ischoegl ischoegl changed the title Minor issues Minor issues for 0.2.0 Dec 3, 2020
@ischoegl
Copy link
Collaborator Author

@DavidAkinpelu ... streamlined the code some more (there were some changes to main). I'm not planning to change anything else until you're done with the remaining items above.

@DavidAkinpelu
Copy link
Contributor

Okay

@ischoegl ischoegl added this to the v0.2.0 milestone Dec 14, 2020
@ischoegl
Copy link
Collaborator Author

@DavidAkinpelu I'm done with my updates, so it's just documentation now.

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

Successfully merging a pull request may close this issue.

2 participants