Documentation - ReadTheDocs about powermodels.jl

[kersulis]

Are you partial to Markdown, or would you like to go with reST/Sphinx like JuMP?

[mlubin]

I'd discourage using RTD. JuMP is gradually migrating away in favor of github pages.

[kersulis]

Good to know. Any technical reason?

So the JuMP doc site will be built by Sphinx and pushed to gh pages in the future?

(Pardon all the questions, I'm working on documentation for another project so I'm curious.)

[mlubin]

Right now we push manually to gh pages: http://www.juliaopt.org/JuMP.jl/0.14/ https://github.com/JuliaOpt/JuMP.jl/blob/master/howto_release.txt

We're moving away from RTD because it's simply been broken on branches for us for more than a year with no fix (readthedocs/readthedocs.org#1617).

[kersulis]

That's too bad about RTD. The current release process seems like a good alternative though.

JuMP documentation is great, and the more I use Sphinx, the more I like it. It's tough to walk away from the simplicity of Markdown, but you gain so much.

[ccoffrin]

I am pretty agnostic to Sphinx and MD, the key bonus in going with Sphinx is in-line docs auto generating API docs. Is this feature not available in Julia?

[mlubin]

See https://github.com/JuliaDocs/Documenter.jl