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

Model documentation #2

Open
hdrake opened this issue May 27, 2020 · 5 comments
Open

Model documentation #2

hdrake opened this issue May 27, 2020 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hdrake
Copy link
Collaborator

hdrake commented May 27, 2020

Should add documentation using Documenter.jl which is mostly made up of documentation markdown files but also also nicely publishes the source code w/ source code docstrings.

@hdrake
Copy link
Collaborator Author

hdrake commented May 27, 2020

I've got a proof-of-concept of this working at https://github.com/hdrake/MARGO.jl/tree/documenting, following the step-by-step Documenter.jl guide, but haven't yet deployed it as a standalone github page.

@hdrake hdrake added the documentation Improvements or additions to documentation label Jun 20, 2020
@hdrake
Copy link
Collaborator Author

hdrake commented Aug 1, 2020

Planning on adding the bare minimum of documentation to #28 before releasing v0.1.0.

  • Landing page
  • Installation instructions
  • A basic example
  • Guide for contributors
  • Description of model parameters (by submodule)
  • Optimization process
  • How to use the diagnostic functions

@hdrake
Copy link
Collaborator Author

hdrake commented Aug 2, 2020

Added some auto-generating docs in #33 with Literate.jl, which turns a basic .jl julia script fill with special comment formatting into a beautiful .md document with code cells and ouputs (including figures!).

@hdrake hdrake added this to the v1.0 release milestone Aug 25, 2020
@hdrake hdrake modified the milestones: v2.0.0 release, v1.0.0 release Jan 17, 2021
@hdrake hdrake self-assigned this Jan 17, 2021
@hdrake
Copy link
Collaborator Author

hdrake commented Dec 27, 2021

Need to be updated to be consistent with the published version of the model!

Edit: As of v0.3.2, the documentation is once again consistent with the model.

@fonsp
Copy link
Member

fonsp commented Feb 9, 2022

The plotting functions still need to be listed 📊

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

No branches or pull requests

2 participants