Skip to content

Commit

Permalink
refactored tutorial docs
Browse files Browse the repository at this point in the history
Moved the tutorials out of the model folder into the docs folder.
Renamed the Boltzmann_Wealth_Model without tutorial in front.
  • Loading branch information
lowcloudnine committed Jun 3, 2016
1 parent 71cd287 commit 24c2437
Show file tree
Hide file tree
Showing 24 changed files with 1,874 additions and 2,178 deletions.
8 changes: 8 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ This folder contains the docs that build the docs for the core mesa code on read

Updating docs can be confusing. Here are the basic setups.

####Create the rST files from ipynb files
1. Change to the appropriate directory (usually docs/tutorials)
* ```cd tutorials```
1. Create rST files using nbconvert
* ```juypter nbconvert --to rST *.ipynb```
1. Move the rst files to the docs directory
* ```mv *.rst ../```

#####Submit a pull request with updates
1. Create branch (either via branching or fork of repo) -- try to use a descriptive name.
* ```git checkout -b doc-updates```
Expand Down
Loading

0 comments on commit 24c2437

Please sign in to comment.