Documentation and Logs

[jac0320]

Proposed Sections on POD Documentation,

• README.md: general description and instructions for POD.jl

• Documenter.jl

  • Introduction: General solver description
  • How to Use: Instruction of installing and using POD with an example
  • Choosing Solver: List of supported sub-solvers and directions on how to use them
  • Algorithm: Big-picture description and point to the paper
  • Expression Guideline: instruction on how different JuMP implementation can affect POD behavior, more detailed description of POD expression operators
  • Parameters: Parameter lists of POD
  • Functions: Docstrings of internal sources, separated by functionality
  • User-defined functions for POD: Advanced usage of POD with examples that contain functional inputs and algorithm tuning

@docstring should be finalized on different branches within the source code. I don't see a reason why we cannot work on different chapters on master directly. The re-base for algorithmic development branches should be simple.

[jac0320]

@rb004f @harshangrjn @kaarthiksundar @hhijazi Register for first version after #54 #75 #74 #73 #72. To me, there are tons of things to work on but I would like to seize the coding at this point with the above PRs.

[jac0320]

@rb004f Can we deploy the documenter ssh key to Github and Travis? I don't have the admin. https://juliadocs.github.io/Documenter.jl/stable/man/hosting/ Thanks!