Documentation Framework #1235
Merged
Documentation Framework #1235
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
- #1225 is showing lots of errors due to using a newer version of doxygen - These doxygen mistakes exist in the current dev/gfdl branch and apparently are missed by the older versions we are using on mom6.readthedocs.io and locally. Todo: [ ] - Have the OBGC routines properly documented so we can replace the "Unknown" documentation in the generic_tracer stubs.
- Repair README & details pages - Edit Makefile and .travis.yml to allow pointing to specific version of doxygen via github - Testing PR for doxygen only right now
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #1235 +/- ##
============================================
- Coverage 46.08% 46.03% -0.06%
============================================
Files 214 224 +10
Lines 69399 71042 +1643
============================================
+ Hits 31984 32702 +718
- Misses 37415 38340 +925
Continue to review full report at Codecov.
|
adcroft
approved these changes
Oct 29, 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.
This replaces PR #1225
RTD: Update .readthedocs.yml for format two; allow the pdf to build
RTD: be sure to add UPDATEHTMLEQS=Y to RTD admin interface
Travis: Use makefile instead of calling binary directly
Travis: add python3-sphinix, remove doxygen as to build from specified version
Makefile: augment arguments to support a variety of doxygen and sphinx-build options
Makefile: move equation post processing from makefile to sphinx-build for RTD purposes
README/details: augment documentation; more needed
postProcessEquations.py: support doxygen 1.8.13
Fix some some src to update math formulas
Moving to doxygen 1.8.13 baseline broke clean pdf generation
There are still a lot of formatting issues to fix for the APIs/gh-pages and RTD. This PR should make the infrastructure for HTML generation at least functional.