Esmg docs #1270
Merged
Esmg docs #1270
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Travis is working again!
- Travis: We can tighten up the warnings to exclude just the specific ones for math provided in `\image html` using the `\f` command. - Bump requirements.txt for sphinxcontrib-autodoc_doxygen module - Add more documentation to README and details. - Synchronize branches again with ESMG; eradicate doxygen binary from development branches postProcessEquations.py - Doxygen tags/references are mangled a bit through processing. Any colon(:) or underscore(_) is translated to a dash (-). - NOTE: Tags and references are non-case sensitive. It seems tags are pushed to lowercase. - Fix regex searches. - Exit with an error if duplicate reference targets are found. - Rewrote DOM manipulation for inserting children for equation renumbering. The previous code was very brittle and assumed the DOM structure was the same. It needed to be more bomb proof with hopes it will work with multiple versions of doxygen. - Added detection of `\notag` support for large equation block so the links work in html but do not create an equation label in the pdf versions. - Make better use of internal maps for references and targets. This still needs more documentation. Doxyfile* - Fix ALIASES commands to add support for doxygen 1.8.13 - Add `\xmlonly` output as older versions do not seem to emit `\latexonly` and `\htmlonly` in XML as we have seen in 1.8.19 - Add ALIASES to simulate `\image latex` support. Native support does not support the ability to pass simple escape sequences. - Documentation that uses equations in figure captions also need to add the image to LATEX_EXTRA_FILES for processing. - Doxygen pdf generation fails with DOT_GRAPHICS_MAX_NODES = 1000. Experimenting with this revealed that 75 is a good value. A value of 100 did fail. src/* file changes: - src/ALE/_ALE.dox: Add \notag to leading html: tag for support of large equation blocks; Fix image captions - src/core/_Discrete_PG.dox: Fix image captions - src/core/_Discrete_grids.dox: Fix image captions - src/core/_General_coordinate.dox: Add \notag to leading html: tag for large equations blocks - src/equation_of_state/_Equation_of_State.dox: Add missing `}`. Might have worked in mathjax, but latex hated it. - src/tracer/_Horizontal_diffusion.dox: Fix image captions
- Remove whitespace in regression.yml - Add files for future debugging work with fortran parser - conf.py: ignore details directory - Release sphinxcontrib-autodoc_doxygen 0.7.13 - Improvements to whitespace handling within xmlutils.py - bump requirements.txt - Update README.md
- Remove "\n" from ALIASES as it tends to be passed through to latex and causes it to fail. - Add/move notes around in README.md and details/.
Doxygen support for 1.8.13 through 1.8.20
adcroft
approved these changes
Dec 10, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some more documentation and another update from @jr3cermak.