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

switch Example page to using DocumenterInterLinks. #47

Open
Fe-r-oz opened this issue Jul 9, 2024 · 5 comments
Open

switch Example page to using DocumenterInterLinks. #47

Fe-r-oz opened this issue Jul 9, 2024 · 5 comments

Comments

@Fe-r-oz
Copy link

Fe-r-oz commented Jul 9, 2024

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
Copy link
Author

Fe-r-oz commented Jul 9, 2024

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

@Fe-r-oz Fe-r-oz changed the title Parameterization should have normalized spelling Parametrization should have normalized spelling Jul 9, 2024
@goerz
Copy link
Member

goerz commented Jul 9, 2024

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

@Fe-r-oz
Copy link
Author

Fe-r-oz commented Jul 9, 2024

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
Copy link
Member

goerz commented Jul 9, 2024

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
Copy link
Author

Fe-r-oz commented Jul 9, 2024

Alright. Cool.

@Fe-r-oz Fe-r-oz changed the title Parametrization should have normalized spelling switch Example page to using DocumenterInterLinks. Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants