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

Update Documentation URLs #3425

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Update Documentation URLs #3425

merged 4 commits into from
Nov 18, 2024

Conversation

mrmundt
Copy link
Contributor

@mrmundt mrmundt commented Nov 18, 2024

Fixes NA

Summary/Motivation:

There were a few missed URLs after the doc reorg that were pointing to stable (which was officially updated as of last Friday when 6.8.1 came out).

Changes proposed in this PR:

  • Fix residual broken URLs

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 November 18, 2024 14:14
Copy link
Member

@jsiirola jsiirola left a comment

Choose a reason for hiding this comment

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

Please update the RST files to use :ref: directives and not full URLs (that will future-proof them)

Apart from that, this is fine, but I wonder if a better (long term) solution is for the Sphinx build to declare a |build| substitution variable (with rst_prolog) that resolves either to latest or stable so that the links automatically point to the correct location?

We might have to update the URL checker to recognize /expand those URLs though?

doc/OnlineDocs/explanation/analysis/doe/doe.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/explanation/analysis/doe/doe.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/explanation/solvers/mindtpy.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/explanation/solvers/mindtpy.rst Outdated Show resolved Hide resolved
@blnicho blnicho dismissed jsiirola’s stale review November 18, 2024 18:53

requested changes have been made

@blnicho blnicho merged commit 5669dfb into Pyomo:main Nov 18, 2024
33 of 34 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.

3 participants