Fix model documentation generation #3088
Merged
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
…g file in write mode so user can see sphinx log. Toctree still not generating correctly.
This was
linked to
issues
Aug 22, 2024
…enerating RST files non-fatal. removes oddly unnecessary sphinx call in `call_regenmodel`. re-instates generation of 'custom models' category in TOC.
…t the same time using locking
…e_documentation.make_html` to reduce number of methods for calling sphinx
…plugin models from TOC
…hen application closes and log window is updated
pkienzle
reviewed
Sep 4, 2024
krzywon
approved these changes
Sep 26, 2024
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.
Description
Fixes bugs in the generation of model documentation preventing it from being generated/displayed correctly. Additionally fixes bug preventing Sphinx logging information appearing in DocRegenInProgress window.
Fixes #3077, #2972
How Has This Been Tested?
Not yet implemented fixes to toctree generation.
Review Checklist:
[if using the editor, use
[x]in place of[ ]to check a box]Documentation (check at least one)
Installers
Licencing (untick if necessary)