QuantEcon / SimpleDifferentialOperators.jl

Library for simple upwind finite differences
MIT License
12 stars 2 forks source link

Some CI steps prior to a new release #216

Open jlperla opened 4 years ago

jlperla commented 4 years ago

@arnavs Maybe you help get this up and running with @ajozefiak

@arnavs if you want to guineapig this with github actions with the docs build, be my guest! Maybe it isn't so hard! The only setup thing to figure out is the documenter.jl stuff. I strongly prefer github actions even it isn't much work.

We want to do a few things to the SDO package prior to tagging a new release

Lets move the PDF into the repository here in https://github.com/QuantEcon/SimpleDifferentialOperators.jl/tree/master/docs/tex

Lets move the notebooks and generated HTML into the repository in https://github.com/QuantEcon/SimpleDifferentialOperators.jl/tree/master/docs/notebooks

For the notebooks, I think we should remove the package and manifest for now if these things are working. that is,

using InstantiateFromURL activate_github_path("QuantEcon/SimpleDifferentialOperators.jl", path = "docs/examples", activate = true)


etc. in the notebooks.  People can figure these packages out themselves for now.
jlperla commented 4 years ago

Note that the github action with documentation looks pretty simple... https://github.com/invenia/PkgTemplates.jl/blob/master/test/fixtures/DocumenterGitHubActions/.github/workflows/ci.yml

Getting the documenter secrets setup properly in https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets would be nice. Much easier than spreading things around.