Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In reference to #136.
I've made a stab at starting to update the documentation using
Documenter.jl
. I'ma bit of a newbie to Julia, but I used
Documenter.jl
to document a simple package I wrote and I feel like I'm getting the hang of it.I thought a good place to start would be to just reformat the existing documentation using
Documenter.jl
, so that's what I've done here. I have not edited any of the existing docstrings or added any of the features ofDocStringExtensions.jl
.The actual html pages with the new layout can be found in the
docs/build
folder.A description of the changes I made follows: comments, questions and feedback are welcome.
docs
folder, replacing the old one, using structure and files needed byDocumenter.jl
and remove references to QuantEcon.Models module which is not present in current
version of QuantEcon
make.jl
for deploying the docs (see here). For auto-deployment of the docs, someone with the appropriate permissions would need to generate SSH Deploy Keys that will allow Travis to push changes to the repository (see here).travis.yml
file to allow for auto-deployment of docs after each new committo the master branch (commented out)
docs/build
to.gitignore
: the default setup is to push auto-generated docsto a
gh-pages
branch, so themaster
branch should not contain these files (see here).