-
Notifications
You must be signed in to change notification settings - Fork 4
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
#70: update doc #75
#70: update doc #75
Conversation
- change options descriptions - use of sub-commands instead of command line options.
36f5445
to
4425b1f
Compare
4425b1f
to
a2d174c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a few minor suggestions which might be a bit cosmetic (feel free to ignore some suggestions).
I think we should have options in the configuration file as subsubsubheadings (with three subs), for example for science_configurations
we replace
+### `science_configurations`
-`science_configurations`
And to reference the section:
This is [a link to `science_configurations`](#`science_configurations`)
Lastly, can we have permalinks for headings? This can enabled by adding the following to mkdocs.yml
:
markdown_extensions:
- toc:
permalink: True
- format options as headings - add permanent links for headings
The changes to the documentation include:
The documentation still needs some documentation to use me.org but it is better to move that to its own ticket I think.