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.

Sign up for GitHub

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

Jump to bottom

documentation #1

Open

2 of 4 tasks

orbeckst opened this issue Apr 2, 2015 · 1 comment

Labels

docs

Member

orbeckst commented Apr 2, 2015 •

edited

Loading

The BornProfiler documentation currently consists mostly of the doc strings or placeholders.

Examples and use of the scripts: how should the typical user make use of the package?
- describe workflow and individual steps
- add figures that show typical output
More prose is needed to explain use of the classes for developers.
No "next" and "previous" links that allow one to quickly click through.
Customize the theme.

orbeckst added the docs label

orbeckst changed the title ~~complete documentation~~ documentation

Member Author

orbeckst commented Sep 4, 2018

Now using alabaster or RTD theme, so two minor things done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment