Skip to content

Move RTD ads to the sidebar #3536

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

Merged
merged 11 commits into from
Apr 15, 2025
Merged

Move RTD ads to the sidebar #3536

merged 11 commits into from
Apr 15, 2025

Conversation

jsiirola
Copy link
Member

@jsiirola jsiirola commented Mar 24, 2025

Fixes # .

Summary/Motivation:

The current RTD builds put the ads in a location that is easily confused with the documentation content. This PR moves the ads to the sidebar where they are less visually confusing (without disabling them completely).

This also sneaks in a resolution to a doc build issue identified by @shermanjasonaf

Changes proposed in this PR:

  • Update the layout template to direct RTD to put the ads in the sidebar and not in the main content
  • Fix a rendering bug in the PyROS documentation (resolves a directive to get line numbers in the output listing)

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.

@jsiirola
Copy link
Member Author

Closing this: either Sphinx or the sphinx-rtd-theme appears to be ignoring the configuration suggested by RTD. We might revisit it some time in the future.

@jsiirola jsiirola closed this Mar 24, 2025
@jsiirola jsiirola reopened this Mar 27, 2025
@jsiirola jsiirola changed the title [WIP] Move RTD ads to the sidebar Move RTD ads to the sidebar Apr 11, 2025
@jsiirola jsiirola requested review from mrmundt and blnicho April 11, 2025 18:16
@github-project-automation github-project-automation bot moved this from Review In Progress to Reviewer Approved in Pyomo Release April 2025 Apr 14, 2025
@blnicho blnicho merged commit 28b0df9 into Pyomo:main Apr 15, 2025
63 of 65 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Pyomo Release April 2025 Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

3 participants