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

Do not use doxygen formulas @f in README #148

Open
marcfehling opened this issue Jun 3, 2023 · 2 comments
Open

Do not use doxygen formulas @f in README #148

marcfehling opened this issue Jun 3, 2023 · 2 comments

Comments

@marcfehling
Copy link
Member

Blunt LaTeX syntax will be displayed correctly in both GitHub Readme and Doxygen. @f is only displayed nicely in Doxygen.

We should choose the format which works nicely in both.

I will upload an example here after #147 gets merged.

@marcfehling
Copy link
Member Author

Swift_Hohenberg-Solver

$$\begin{aligned}
    \frac{\partial u}{\partial t} = ru - (k_c + \Delta)^2 u + g_1 u^2 - u^3
\end{aligned}$$

Distributed_LDG_Method:

@f{align}
- \nabla \cdot  \left(\ \nabla u \ \right)&= f(\textbf{x}) && \mbox{in} \
\Omega,\nonumber \\
-\nabla u \cdot \textbf{n}  &= g_{N}(\textbf{x}) && \mbox{on} \ \partial 
\Omega_{N} \nonumber\\
u &= g_{D}(\textbf{x}) && \mbox{on}  \ \partial \Omega_{D}. \nonumber
@f}

@bangerth
Copy link
Member

#149 replaces the $$\begin{aligned} thing to proper doxygen markup. I would say that doxygen input is the canonical style. If we can make it work for markdown, that's nice, but that's not high on my list of priorities.

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