search

Gurobi / gurobi-machinelearning

Formulate trained predictors in Gurobi models
https://gurobi-machinelearning.readthedocs.io/
Apache License 2.0
215 stars 44 forks source link

switch to Gurobi Sphinx theme #326

Closed mattmilten closed 2 months ago

mattmilten commented 4 months ago

~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 commented 2 months ago

@mattmilten I made a few tweaks.

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

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.

mattmilten commented 2 months ago

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 commented 2 months ago

OK thanks for create the items.

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