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

switch to Gurobi Sphinx theme #326

Merged
merged 5 commits into from
Sep 6, 2024
Merged

switch to Gurobi Sphinx theme #326

merged 5 commits into from
Sep 6, 2024

Conversation

mattmilten
Copy link
Member

No description provided.

@mattmilten mattmilten requested a review from pobonomo July 23, 2024 11:03
@mattmilten
Copy link
Member Author

mattmilten commented Jul 23, 2024

Only issue right now is that the warning banner about the beta documentation is baked into the theme and also shows up here, which makes no sense. We could just wait until the docs have officially moved and this banner is removed.

I found the option to disable those 😄

@pobonomo pobonomo force-pushed the use-gurobi-theme branch 2 times, most recently from 6897a79 to fe895a7 Compare September 4, 2024 21:24
@pobonomo
Copy link
Member

pobonomo commented Sep 5, 2024

@mattmilten I made a few tweaks.

There are two things that annoy me in particular with the current theme:

  • The Gurobi Optimization logo linking to the top page of the documentation of Gurobi ML. I think that it is confusing. I would expect a Gurobi logo to link to gurobi.com. I also don't like that there is no link to gurobi.com in every page of the documentation.
  • I think that the name of the package or title of the documentation should appear in every page.

I could tweak the sidebar to fix these two now (normally you can see the result there https://gurobi-machinelearning.readthedocs.io/en/use-gurobi-theme/).
Overall, I am not sure it is really more ergonomic than the current theme but fine.

Maybe you should consider the tweaks for the theme itself.

@pobonomo pobonomo changed the base branch from main to 1.5.x September 5, 2024 09:05
Modify sidebar so that the gurobi logo links to gurobi.com
and put back the name of this manual.

Some other tweaking.
@mattmilten
Copy link
Member Author

mattmilten commented Sep 5, 2024

There are two things that annoy me in particular with the current theme:

  • The Gurobi Optimization logo linking to the top page of the documentation of Gurobi ML. I think that it is confusing. I would expect a Gurobi logo to link to gurobi.com. I also don't like that there is no link to gurobi.com in every page of the documentation.
  • I think that the name of the package or title of the documentation should appear in every page.

I could tweak the sidebar to fix these two now (normally you can see the result there https://gurobi-machinelearning.readthedocs.io/en/use-gurobi-theme/). Overall, I am not sure it is really more ergonomic than the current theme but fine.

Maybe you should consider the tweaks for the theme itself.

Yes, these things really are not ideal and should be fixed in the theme instead. I added issues https://github.com/Gurobi/docs-frontpage/issues/31 and https://github.com/Gurobi/docs-frontpage/issues/30 to address this.

@pobonomo
Copy link
Member

pobonomo commented Sep 6, 2024

OK thanks for create the items.

In spite of these two small things I am starting to like it. So I'll merge this.

@pobonomo pobonomo merged commit 95c4b4c into 1.5.x Sep 6, 2024
9 checks passed
@pobonomo pobonomo deleted the use-gurobi-theme branch September 7, 2024 15:51
Copy link
Member

@pobonomo pobonomo left a comment

Choose a reason for hiding this comment

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

Good

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.

2 participants