Local documentation generation #2576
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
Makefile + regenmodel.py
Regeneration of HTML succeeds using Makefile *but* doctree not generating correctly for models.
(also added explanation to currently not in use make command)
…O fix filepaths so that makedocumentation runs
…xes error passing in single argument to regenmodel
…se it when finished
|
It seems that this PR is failing at the notarization step. I am looking into more details |
|
It seems that some of Qt folders/modules are not signed. I am not sure but we may need to include more folder in fix_qt_folders script |
|
Here is the log: |
This was referenced Jan 16, 2024
This was referenced Jan 17, 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
WORK IN PROGRESS
Overhauls documentation viewing and editing system. When 'Help' is pressed anywhere in SasView, a window now appears that displays documentation using QT's WebViewEngine widget. This window also has buttons to edit the documentation, which will pull up the relevant RST (if user documentation) or Python file (if a model). When the 'Save' button is pressed, the relevant documentation is regenerated using a python to RST converter (if a model) and a somewhat skimmed-down version of Sphinx. A refresh of any open documentation windows is then triggered upon completion of the regeneration, displaying the user's changes. User-created documentation will also be generated and will display when 'Help' is pressed.
Sphinx will need to be included as a dependency for this update to work.
TODO
Fix various bugs, and, importantly, make sure the required files get ported over to the installed version and everything works on installed version.
Fixes #706
How Has This Been Tested?
Waiting for fixing of final bugs before describing
Review Checklist: