search

JuliaDynamics / DynamicalSystems.jl

Award winning software library for nonlinear dynamics and nonlinear timeseries analysis
https://juliadynamics.github.io/DynamicalSystemsDocs.jl/dynamicalsystems/dev/
Other
842 stars 94 forks source link

Hacky test for JuliaDynamics/ChaosTools.jl#109 #109

Closed asinghvi17 closed 4 years ago

Datseris commented 4 years ago

It doesn't seem to work for me: https://juliadynamics.github.io/DynamicalSystems.jl/previews/PR109/chaos/nlts/#ChaosTools.numericallyapunov

clicking the "1" doesn't bring me to the citation.

asinghvi17 commented 4 years ago

Let me try one thing. I think the spacing may play a role here...

Datseris commented 4 years ago

@asinghvi17 This worked now. Unfortuantely we cannot merge this change. Please have a look at the Docs and you will realize why.

The references go at the bottom of the page with number "1". Now, if you look at the Broomhead king method, it also has a reference of number "1". This is ambiguous, which 1 is the broomhead, which 1 is the Lyapunovs...? And I don't think it is reasonable to start tracking citations in the docs.

asinghvi17 commented 4 years ago

Makes sense. Unless we use author names or something as markers, it would get complicated.

Datseris commented 4 years ago

What we could do, is modify all docstrings to have different code names instead of numbers (e.g. LastName-Date, e.g. Lyapunov1902, Pecora2007, etc.). Does the citations that go to the end of the page work with this kind of syntax as well?

What happens when one has the same code word across different docstrings? Can you check this?

Datseris commented 4 years ago

Does the same syntax work with codeworrds instead of numbers @asinghvi17 ? If it does, then that is the solution.

Datseris commented 4 years ago

Seems to work, right?!

asinghvi17 commented 4 years ago

Yes, it seems to work! Beware that you can only use 1 line for the footnote, though, and you may want to omit the ## References headers from the docstring.