Skip to content
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

Starting new documentation #138

Merged
merged 2 commits into from
Feb 4, 2017
Merged

Starting new documentation #138

merged 2 commits into from
Feb 4, 2017

Conversation

stephenbnicar
Copy link
Contributor

In reference to #136.

I've made a stab at starting to update the documentation using Documenter.jl. I'm
a 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 of DocStringExtensions.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.

  • New docs folder, replacing the old one, using structure and files needed by Documenter.jl
  • The initial new site layout mostly mirrors the old one:
    • Home: Taken from current documentation and edited to remove/fix broken links
      and remove references to QuantEcon.Models module which is not present in current
      version of QuantEcon
    • API/QuantEcon: docstrings from QuantEcon.jl organized by Exported and Internal
    • Contributing: taken from quant-econ.org site
    • no user guide yet, but a new page can be added easily when written
  • Included commented-out code in 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).
  • Updated travis.yml file to allow for auto-deployment of docs after each new commit
    to the master branch (commented out)
  • Added docs/build to .gitignore: the default setup is to push auto-generated docs
    to a gh-pages branch, so the master branch should not contain these files (see here).

@coveralls
Copy link

Coverage Status

Coverage remained the same at 93.287% when pulling 477a28a on stephenbnicar:startnewdocs into 0030fae on QuantEcon:master.

@codecov-io
Copy link

Current coverage is 93.28% (diff: 100%)

Merging #138 into master will not change coverage

@@             master       #138   diff @@
==========================================
  Files            19         19          
  Lines          1147       1147          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1070       1070          
  Misses           77         77          
  Partials          0          0          

Powered by Codecov. Last update 0030fae...477a28a

@sglyon
Copy link
Member

sglyon commented Aug 23, 2016

Thank you very much for working on this! I will try to review and merge within the next day or two

@jstac
Copy link
Contributor

jstac commented Aug 23, 2016

@stephenbnicar Thanks, much appreciated.

@sglyon
Copy link
Member

sglyon commented Feb 4, 2017

I'm really sorry this sat for so long. Somehow it slipped through my radar after I initially saw it.

I am going to merge right now and make a couple minor adjustments.

@sglyon sglyon merged commit dcb18bf into QuantEcon:master Feb 4, 2017
@stephenbnicar
Copy link
Contributor Author

No problem. Glad to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants