-
Notifications
You must be signed in to change notification settings - Fork 16
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
Generated with Sphinx documentation added to make it available to users. #36
Conversation
…include), copy this file to iterative "iter_matfile" and store this file path and name.
Update simulation.py
Can you share a link where these docs are rendered? |
Now it is available here: http://andrewryh.github.io/saltproc/ |
After merging it will be here: http://arfc.github.io/saltproc/ |
@@ -0,0 +1,6 @@ | |||
Examples | |||
========= | |||
|
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.
The examples page should be more descriptive, if not a full tutorial.
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.
@anshchaube
Commit df2c7fe
Please check out changes here: https://andrewryh.github.io/saltproc/examples.html
Don't wanna add a detailed description of input syntax yet, because it is constantly changing.
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.
Looks good. Minor correction - "...and reprocessing system components' ..."
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.
Thanks for catching this! Fixed
82c7cae
Sorry for messy PR: Github by default making new branch from master, but gh-pages branch should contain the only website with documentation.
That is why you see tons of files removed and a few new files with documentation added.