2/17/2024 0 Comments Doxygen equationsI see that Doxygen let you use long comments in the code itself, so you'll probably want to the markdown cell of notebooks represented as scripts to have a Doxygen-compatible representation. What is your expectation on round trips? I mean, if the Doxygen form is found in a notebook, say $\f[$, is it OK to replace it with $$ after a round trip (I mean, we don't go further than applying simple replacements)? Maybe again an additional format option would be the way to go, as you probably want to apply these transformation not only for the Markdown format, but maybe also for the code formats? What would be a good name for the option? Something like doxygen_latex_markers?Īnd the last question is mine. Performs the following find-and-replace operations And meanwhile, yes, using notebook_metadata_filter="-all" is probably what I would suggest to use! comment_notebook_metadata to allow this (note that, since the metadata is in YAML format, I'd prefer to keep the -, and enclose it in the HTML comment, rather than to replace with the HTML comment). Maybe we could offer an additional format option like e.g. That's a great idea! And not only for DOxygen - even on GitHub sometimes we don't want to see the file metadata. That switches the metadata at the top to use instead of. Let me answer a few points and add a few more questions. Hello, thanks for sharing your use case! That's very interesting. It seems like the path of least resistance is adding a Doxygen-specific markdown format to jupytext that switches the metadata at the top to use instead of - (or just removes the metadata, which is already possible with default_notebook_metadata_filter) and performs the following find-and-replace operations to match Doxygen LaTeX syntax: FindĪm I on the right path? Would this be valuable? Would Jupytext allow us to automatically keep either of these* files in sync? SyncedĮxample of page generated by : I manually created a Doxygen C-style comment file and a Doxygen Markdown format file that contain the same content but have been updated to correctly render Doxygen. ipynb file with LaTeX equations, I paired it with. Jupyter Notebook for quick interactive visualizations.Doxygen for overall project documentation.Any suggestions for the best way to use or update jupytext to support this workflow? I have a test project available at CodyM48/aircraft-motion that describes the problem statement in the README.md:Īttempting to find the best combination of two tools: Soc.Outstanding project, I can see this being very useful.įor some other large mixed-language (Python and C++) repositories, we're using Doxygen as the main documentation tool. Wegert, E., Semmler, G.: Phase plots of complex functions: A journey in illustration. Press, W.H., Teukolsky, S.A., Wetterling, W.T., Flannery, B.P.: Numerical Recipes: The Art of Scientific Computing, 3rd edn. Olver, F.W.J., Lozier, D.W., Boisvert, R.F., Clark, C.W.: NIST Handbook of Mathematical Functions. Mohan, C., Al-Bayaty, A.R.: Power series solutions of the Lane–Emden equation. from the Conference, “On Formal and Analytic Solutions of Differential and Difference Equations II”, vol. 97, pp. Kycia, R.A.: On movable singularities of self-similar solutions of semilinear wave equations. Kycia, R.A., Filipuk, G.: On the singularities of the Emden-Fowler type equations. Ince, E.L.: Ordinary Differential Equations. Hunter, C.: Series solutions for polytropes and the isothermal sphere. Hille, E.: Ordinary Differential Equations in the Complex Domain. Goriely, A.: Integrability and Nonintegrability of Dynamical Systems. Gamma, E., Helm, R., Johnson, R., Vlissides, J.: Design Patterns: Elements of Reusable Object-oriented Software, 1st edn. Dover Publications (2010)įornberga, B., Weideman, J.A.C.: A numerical methodology for the Painlevé equations. Springer (1999)ĭavis, H.T.: Introduction to Nonlinear Differential and Integral Equations. Chem. 693, 95–104 (2013)īutcher, J.C.: Numerical Methods for Ordinary Differential Equations, 2nd edn. Cambridge University Press (2003)īieniasz, L.K.: Automatic solution of the Singh and Dutt integral equations for channel or tubular electrodes, by the adaptive Huber method. MIT Press and McGraw-Hill (1996)Īblowitz, M.J., Fokas, A.S.: Complex Variables: Introduction and Applications, 2nd edn. Abelson, H., Sussman, G.J., Sussman, J.: Structure and Interpretation of Computer Programs, 2nd edn.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |