search

JuliaLinearAlgebra / IterativeSolvers.jl

Iterative algorithms for solving linear systems, eigensystems, and singular value problems
MIT License
401 stars 106 forks source link

Docs for LOBPCG method missing #211

Closed dkarrasch closed 6 years ago

dkarrasch commented 6 years ago

Scanning through the releases I realized that at version v0.6.0 another eigensolver named LOBPCG was introduced. Text searching the docs didn't yield a single hit. Would be nice to have a little bit of background and recommendations for usage etc.

haampie commented 6 years ago

ping @mohamed82008

mohamed82008 commented 6 years ago

That's unfortunate. Is there any specific reason why Documenter.jl (or Literate.jl) was not used before to put the docstrings into the docs, just time limitation? I never used these before but I am sure you know they are quite popular, especially Documenter. I think Literate.jl can also add Jupyter notebooks to the docs.

mohamed82008 commented 6 years ago

I think JuMP uses http://www.sphinx-doc.org/en/master/

haampie commented 6 years ago

Just add a page to https://github.com/JuliaMath/IterativeSolvers.jl/tree/master/docs/src and reference it in https://github.com/JuliaMath/IterativeSolvers.jl/blob/master/docs/make.jl, that's all.

Might as well bump https://github.com/JuliaMath/IterativeSolvers.jl/blob/master/docs/make.jl#L40 when you're at it :)

mohamed82008 commented 6 years ago

Close issue? https://juliamath.github.io/IterativeSolvers.jl/latest/eigenproblems/lobpcg.html