search

geodynamics / aspect

A parallel, extensible finite element code to simulate convection in both 2D and 3D models.
https://aspect.geodynamics.org/
Other
228 stars 238 forks source link

documentation: replace \cite by {cite} #5414

Closed tjhei closed 1 year ago

tjhei commented 1 year ago

The parameter documentation contains many latex citations, see git grep "\\cite" source/. This need to be changed from \\cite{bla} to {cite}`bla` and each backtick needs to be escaped as \\`, see #5413.

We also need to check if the citation keys are correct, of course.

@alarshi Can you please take a look at this?

alarshi commented 1 year ago

Yes, will do!

bangerth commented 1 year ago

We could also just let the conversion script replace \cite{...} by the appropriate sphinx command.

tjhei commented 1 year ago

I am fine with either option. @alarshi you can also add the replacement to the script https://github.com/geodynamics/aspect/blob/c673dc24a655c298babb7a09365cf75beade6398/contrib/utilities/jsontomarkdown.py#L89C22-L89C28

I think for \cite{} this is a decent option.