Opened 3 weeks ago

Last modified 3 weeks ago

#6872 new defect

HTML generation differences (@subheading missing, formatting) in local build compared to official build

Reported by: jdlh Owned by:
Priority: minor Component: documentation
Version: git-master Keywords: texi doc
Cc: Blocked By:
Blocking: Reproduced by developer: no
Analyzed by developer: no

Description

Summary of the bug: When compiling documentation in TexInfo (*.texi) format on a local workstation, there are differences in the resulting HTML output compared to the HTML generated by the official build process on the ffmpeg.org site. Differences include: @subheading directives are not emitted to HTML, and styling differs.

How to reproduce:

% git checkout master
% make doc
[Open doc/developer.html in web browser]
[Open official http://ffmpeg.org/developer.html in web browser]

Observed behaviour:

  1. @subheading directives in doc/developer.texi generate HTML with no <h4> tags in local builds.

For instance, in the local build of doc/developer.html, the following lines occur:

<a name="You-must-not-commit-code-which-breaks-FFmpeg_0021"></a>
<p>This means unfinished code which is enabled and breaks compilation,
or compiles but does not work/breaks the regression tests.

… [remainder elided]

  1. Text styling differs in local build compared to official build.

In the local build of doc/developer.html, the <h3 class="section"> elements are styled with grey text, and the paragraphs have wide margins with respect to the frame width.

Expected behaviour:

  1. @subheading directives in doc/developer.texi generate <h4> tags, same as in the official build

In the official ffmpeg.org build of doc/developer.html, the corresponding lines to the "expected behaviour" 1. above are,

<a name="You-must-not-commit-code-which-breaks-FFmpeg_0021"></a>
<h4 class="subheading">You must not commit code which breaks FFmpeg!</h4>
<p>This means unfinished code which is enabled and breaks compilation,
or compiles but does not work/breaks the regression tests. 

… [remainder elided]

Note the presence of the <h4 class="subheading"> element.

  1. Text styling is the same in local build as in the official build.

In the official ffmpeg.org build of doc/developer.html, the <h3 class="section"> elements are styled with green text, and the paragraphs fill the frame width.

Change History (1)

comment:1 Changed 3 weeks ago by cehoyos

  • Priority changed from normal to minor
Note: See TracTickets for help on using tickets.