Consider changing to fork from sphinx-material

[daniellimws]

A few months back @mgielda mentioned that there is a better sphinx material theme at https://github.com/bashtage/sphinx-material. It is a lot better than the one we are currently using, as the current one uses MDL which is already deprecated and has various css problems at times. The Symbiflow examples documentation page has changed to use this theme.

I made a fork of the sphinx-material theme to include the things we added (e.g. symbiflow-related links at the header and footer).

@mithro What do you think about changing to this theme? From trying it out, it doesn't seem to have those weird css problems that we used to have, and everything also seems to load faster. We could make a new repo called sphinx_symbiflow_theme_v2 if we are worried about breaking any existing documentation sites using this theme. But I've tried it on some existing repos and so far they work without needing to change anything in conf.py, so we could also consider just replacing everything in this repo.

Only thing we need to manually set is the theme color.

[mithro]

I'm all for moving to the theme @mgielda identified once we have added the set of features we added to the old theme.

[mithro]

@daniellimws -- I'm unsure if we have a list anywhere of the features missing in the new theme?

[daniellimws]

@mithro I looked through the PRs made and have implemented all the features that I added. They are either CSS fixes which shouldn't be needed in the new theme, or symbiflow related links in the header and footer which I already added to my fork of the new theme.

[mithro]

@daniellimws Shall we give it a go then?

[mithro]

f4pga/sphinx_f4pga_theme#1

[daniellimws]

@mithro shall we close this?

[mithro]

@daniellimws Let's wait until we have deployed the theme everywhere?

[mithro]

Looks like it is broken at https://readthedocs.org/projects/sphinx-verilog-domain/builds/13133892/ ?

sphinx-verilog-domain | Read the Docs

[daniellimws]

@mithro Sorry for the late response. I think we need to push the new theme to pypi asap. Can you do that?

[daniellimws]

Just remembered we never push to pypi, but just install from github directly. My bad :p