Skip to content
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

Merged
merged 7 commits into from
Sep 15, 2021

Conversation

jprestop
Copy link
Collaborator

Pull Request Testing

Pull Request Checklist

See the METplus Workflow for details.

  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    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
  • After submitting the PR, select Linked issues with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

…n to point to installation instructions for MET
@jprestop jprestop added this to the METplus-4.0.1 Bugfix milestone Sep 14, 2021
@jprestop jprestop linked an issue Sep 14, 2021 that may be closed by this pull request
22 tasks
Copy link
Collaborator

@georgemccabe georgemccabe left a 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?

@jprestop
Copy link
Collaborator Author

@georgemccabe

It looks like all of the bullet lists no longer have dots anymore.
I am so glad you looked at the pages. I reviewed them and didn't even notice that. Thank you so much. I'll take a look now.

@jprestop
Copy link
Collaborator Author

@georgemccabe
Yes, something is very wrong. Even the asterisks for the lists on the release-notes are broken and I didn't even touch that page:
https://metplus.readthedocs.io/en/feature_1067_main_v4.0_install_instruct/Users_Guide/release-notes.html

Julie Prestopnik and others added 3 commits September 14, 2021 17:09
Copy link
Collaborator

@georgemccabe georgemccabe left a 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.

@georgemccabe georgemccabe merged commit 912fc93 into main_v4.0 Sep 15, 2021
@georgemccabe georgemccabe deleted the feature_1067_main_v4.0_install_instruct branch September 15, 2021 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix installation instructions in User's Guide
2 participants