-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feature 1067 main_v4.0 install instruct #1155
feature 1067 main_v4.0 install instruct #1155
Conversation
…n to point to installation instructions for MET
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like all of the bullet lists no longer have dots anymore. Perhaps it is caused by the extra dash (-) characters in the list items. You could try escaping that character?
|
@georgemccabe |
…led by RTD - fixes issue where bulleted lists bullets disappeared
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reviewed the changes and they all look good. They involve updating the documentation to clearly direct users to the MET installation section of the User's Guide to install MET, removed the section describing the build_MET.sh script because it currently does not work, and some various formatting cleanup.
We discovered that unrelated to these changes, a new version of sphinx and sphinx-rtd-theme caused the bullets in the bulleted lists to disappear. We discovered that two python package versions changed (charset-normalizer-2.0.5 and docutils-0.17.1) and one of them didn't play nicely with the version of sphinx we have been using. We decided to remove the requirements for building the docs in ReadTheDocs to use the version of sphinx and sphinx-rtd-theme that RTD automatically installs. We previously were downgrading the versions of some sphinx packages that risk package conflicts. Using the latest version of sphinx and the sphinx RTD package will reduce the risk of issues and automatically incorporate improvements/bugfixes. Julie and I reviewed the docs and determined that any differences in formatting were improvements.
I approve of this PR.
Pull Request Testing
Describe testing already performed for these changes:
Worked with George to update the installation instructions. Looked at the following pages to ensure proper formatting:
https://metplus.readthedocs.io/en/feature_1067_main_v4.0_install_instruct/Users_Guide/installation.html
https://metplus.readthedocs.io/en/feature_1067_main_v4.0_install_instruct/Users_Guide/systemconfiguration.html
Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
Review files changed.
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
Do these changes include sufficient testing updates? [Yes]
Will this PR result in changes to the test suite? [No]
Please complete this pull request review by [09/17/21].
Pull Request Checklist
See the METplus Workflow for details.
Select: Reviewer(s)
Select: Organization level software support Project or Repository level development cycle Project
Select: Milestone as the version that will include these changes