JuliaQuantumControl / Krotov.jl

Julia implementation of Krotov's method for quantum optimal control
https://juliaquantumcontrol.github.io/Krotov.jl
MIT License
7 stars 2 forks source link

switch Example page to using DocumenterInterLinks. #47

Open Fe-r-oz opened 3 months ago

Fe-r-oz commented 3 months ago

In the krotov.jl documentation section, the spelling of parameterization is not normalized.

Please see here: https://juliaquantumcontrol.github.io/Krotov.jl/stable/examples/ This leads to QuantumControlExamples.jl where we have the same issue.

I will fix this soon.

Fe-r-oz commented 3 months ago

It seems like the documentation for Tutorial section for QuantumControlExamples is not rendering the latest changes introduced by the parameterization normalization PR.

For example, in the repo, the spelling are normalized

https://github.com/JuliaQuantumControl/QuantumControlExamples.jl/blob/master/tutorials/krotov_pulse_parameterization/krotov_pulse_parameterization.jl

but when I open the documentation, the spelling are not normalized

https://juliaquantumcontrol.github.io/QuantumControlExamples.jl/stable/tutorials/krotov_pulse_parametrization/#Pulse-Parametrization-for-Krotov's-Method

goerz commented 3 months ago

The QuantumControlExamples are deployed manually when there are major releases, not automatically on every push. This is intentional.

Fe-r-oz commented 3 months ago

Alrighty! Thanks. I guess I just need to appy small fix here: https://github.com/JuliaQuantumControl/Krotov.jl/blob/master/docs/src/examples.md

goerz commented 3 months ago

The Examples Page in the Krotov docs needs a different approach anyway. At the very least, it should be using DocumenterInterLinks to link to subpages of https://github.com/JuliaQuantumControl/QuantumControlExamples.jl/. Or, what I actually had in mind was for QuantumControlExamples.jl to have a more specialized TOML file that lists all the examples/tutorial and their metadata (like tags), alongside a special Documenter plugin that could automatically expand a list of tutorials/examples based on tags. All of this is work in progress.

For the time being, if you're going to fix anything on that examples page at all, switch it to using DocumenterInterLinks. But it's fairly low-priority.

Fe-r-oz commented 3 months ago

Alright. Cool.