search

noi-techpark / odh-docs

Open Data Hub (http://opendatahub.com/) Documentation
http://opendatahub.readthedocs.io/en/latest/index.html
4 stars 4 forks source link

Evaluate migration of sphinx-panels to sphinx-design #233

Closed stefanodavid closed 3 years ago

stefanodavid commented 3 years ago

In https://github.com/executablebooks/sphinx-panels/issues/67 it is mentioned that the sphinx-panel extension is going to be deprecated in favour of https://github.com/executablebooks/sphinx-design.

The new extension seems more usable (easier config and definition of roles and directive's options) than sphinx-panels so it's definitely worth trying it out.

Major changes and breaking changes are written on their README.md; ongoing discussion on https://github.com/executablebooks/sphinx-design/issues/6

stefanodavid commented 3 years ago

I started the migration and the panels:: look fine and are easier to configure.

stefanodavid commented 3 years ago

The new sphinx-design extension is definitely easier to use, although the migration had a bunch of points that needed to be careful as the syntax of some elements changed a lot.