Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Update json2md.py #779

Merged
merged 7 commits into from
Oct 22, 2020
Merged

Update json2md.py #779

merged 7 commits into from
Oct 22, 2020

Conversation

dchassin
Copy link
Member

@dchassin dchassin commented Oct 12, 2020

This PR adds options to control the output from the JSON to markdown converter.

Current issues

None

Code changes

  • Add options to control inclusion/exclusion of module, class, object, and global sections, as well as options to include table of contents and hyperlinks.

Documentation changes

Test and Validation Notes

  • Update gldcore/autotest/test_markdown.glm to include contents and hyperlinks.

@dchassin dchassin added the enhancement Request an enhancement or new feature label Oct 12, 2020
@dchassin dchassin added this to To do in GLOW via automation Oct 12, 2020
@dchassin dchassin moved this from To do to Review pending in GLOW Oct 12, 2020
@dchassin dchassin marked this pull request as ready for review October 12, 2020 16:00
@aivanova5
Copy link
Collaborator

Should the documentation include script level globals in the .md?

For example, setting:

#set glm_save_options=MINIMAL

...doesn't output docs for glm_save_options in the default md (ie no options set). The --no_globals option only applies to module level globals.

@dchassin
Copy link
Member Author

For example, setting:

#set glm_save_options=MINIMAL

doesn't output docs for glm_save_options in the default md (ie no options set). The --no_globals option only applies to module level globals.

If the global is listed in the json file, then it should be output when the option is enable. Is it listed? If not, then it's a problem with JSON output, not MD conversion. If not, then it's a problem with MD conversion.

@aivanova5
Copy link
Collaborator

For example, setting:

#set glm_save_options=MINIMAL

doesn't output docs for glm_save_options in the default md (ie no options set). The --no_globals option only applies to module level globals.

If the global is listed in the json file, then it should be output when the option is enable. Is it listed? If not, then it's a problem with JSON output, not MD conversion. If not, then it's a problem with MD conversion.

Actually, I did find them (they're capitalized). However, no description of the variable is listed, just type and value.

GLOW automation moved this from Review pending to Merge pending Oct 22, 2020
@aivanova5 aivanova5 merged commit b8d23cd into develop Oct 22, 2020
GLOW automation moved this from Merge pending to Done Oct 22, 2020
@aivanova5 aivanova5 deleted the develop-add-markdown-output-options branch October 22, 2020 16:16
@dchassin dchassin mentioned this pull request Oct 26, 2020
17 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Request an enhancement or new feature
Projects
No open projects
GLOW
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants