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

Set sphinx-material theme for documentation #867

Closed

Conversation

fabcor-maxiv
Copy link
Contributor

No description provided.

@fabcor-maxiv
Copy link
Contributor Author

@fabcor-maxiv fabcor-maxiv force-pushed the docs-theme-sphinx-material branch from 7d6760c to 27ad810 Compare March 14, 2024 15:58
@marcus-oscarsson
Copy link
Member

It looks quite nice, but there seems to be items missing in the contents right ?

@fabcor-maxiv fabcor-maxiv force-pushed the docs-theme-sphinx-material branch from 27ad810 to 8ccc1d5 Compare March 18, 2024 09:10
@marcus-oscarsson
Copy link
Member

thanks, It looks nice but it has the same issue as furo with the API contents I believe (not all the text is shown)

@fabcor-maxiv
Copy link
Contributor Author

There has to be a way to improve this. I have some ideas, but have not had the time to try them yet. Well, one or two I tried and it did not improve things.

Maybe there is another theme out there that fits our needs better.

@marcus-oscarsson
Copy link
Member

I'm sure there is some way as well, lets go with whats easiest for now unless you really want to dig into this.

@marcus-oscarsson
Copy link
Member

Input on this one, do we keep the current layout or do we try this one, seeing that both are suffering from similar limitations when it comes to the left side menu ?

@fabcor-maxiv
Copy link
Contributor Author

The one we have at least does not truncate the names in left and right columns, and in general I think I prefer the one we currently have.

So if it were only me, for now, I would leave as is (furo).

But I still intend to spend some time fiddling with configuration settings and themes and maybe I find a better compromise.

furo (current):

image

sphinx-material:

image

@marcus-oscarsson
Copy link
Member

Ok, We will keep it open for now then, you can close it if you consider it as done

@marcus-oscarsson
Copy link
Member

Closing this for now, please feel free to re-open if you like

@fabcor-maxiv fabcor-maxiv deleted the docs-theme-sphinx-material branch July 3, 2024 08:37
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