[Intel-gfx] [maintainer-tools PATCH 5/5] doc: use Sphinx bizstyle builtin html theme

[Jani Nikula]

On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi at gmail.com> wrote:
> On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula at intel.com> wrote:
>> Matter of taste, but looks better than the default alabaster,
>
> not sure which one I preferred...
> alabaster goes better with 01.org... but it indeed is not very good...
>
>> and is
>> less trouble than requiring some external themes (such as the sphinx rtd
>> theme used in the kernel).
>
> less trouble is good, but since we are already making changes now and
> forcing new packages I believe we could force to use same style as
> kernel so we keep in sync...

Looks like sphinx_rtd_theme is builtin since Sphinx 1.3, and I think we
could easily require that.

The trouble is that the sphinx_rtd_theme forces a fairly narrow layout
horizontally, without horizontal scroll bars, and the wavedrom timeline
overflows the content box and is clipped at the window border. Fail.

I peeked at the Sphinx wavedrom extension, and incorporated their raw
html hack to provide scrollbars for overflowing content. With hack [1],
without hack [2].

What do people think?

(Perhaps the right answer is to use something other than wavedrom
altogether, but I don't have the time and I don't want it to block the
Sphinx conversion.)


BR,
Jani.


[1] https://people.freedesktop.org/~jani/html/drm-intel.html#merge-timeline
[2] https://people.freedesktop.org/~jani/html/drm-misc.html#merge-timeline



>
>>
>> Signed-off-by: Jani Nikula <jani.nikula at intel.com>
>> ---
>>  conf.py | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/conf.py b/conf.py
>> index 2e7acb8e76ca..7293d9ddab80 100644
>> --- a/conf.py
>> +++ b/conf.py
>> @@ -119,7 +119,7 @@ todo_include_todos = False
>>  # The theme to use for HTML and HTML Help pages.  See the documentation for
>>  # a list of builtin themes.
>>  #
>> -html_theme = 'alabaster'
>> +html_theme = 'bizstyle'
>>
>>  # Theme options are theme-specific and customize the look and feel of a theme
>>  # further.  For a list of options available for each theme, see the
>> --
>> 2.11.0
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx at lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center