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

Add URL Checking to Markdown + Doc Files #3259

Merged
merged 6 commits into from
May 14, 2024
Merged

Conversation

mrmundt
Copy link
Contributor

@mrmundt mrmundt commented May 13, 2024

Fixes NA

Summary/Motivation:

Because I like to make our pre-test linting suite as complicated as possible, this adds yet another element: URL checking! The action in use here checks all Markdown and RST files and makes sure that the URLs work. It ignores pyomo-jenkins, however, because that's behind a firewall.

Changes proposed in this PR:

  • Check URLs to make sure that they work (in Markdown and RST files)
  • Fix broken URLs
  • Remove the section on "Including External Packages" because we don't actually support that anymore and the URL for the one example was broken

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@mrmundt mrmundt requested review from blnicho and jsiirola May 13, 2024 21:47
Copy link
Contributor

@michaelbynum michaelbynum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it! I hate broken links!

@mrmundt mrmundt merged commit f2a311a into Pyomo:main May 14, 2024
32 of 33 checks passed
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.

None yet

3 participants