Task #91199

dashboard documentation: Fix some warnings in docs generation

Added by Sybille Peters 2 months ago. Updated 2 months ago.

Status:
Closed
Priority:
Should have
Category:
Documentation
Target version:
-
Start date:
2020-04-26
Due date:
% Done:

100%

TYPO3 Version:
10
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

dashboard

./Documentation/Developer/Interfaces.rst:137: WARNING: Field list ends without a blank line; unexpected unindent.
./Documentation/Developer/Interfaces.rst:148: WARNING: Field list ends without a blank line; unexpected unindent.
./Documentation/Widgets/NumberWithIconWidget.rst:40: WARNING: Literal block ends without a blank line; unexpected unindent.
WARNING: unsupported theme option 'show_sphinx' given
WARNING: unsupported theme option u'show_legalinfo' given
WARNING: unsupported theme option 'use_opensearch' given
WARNING: unsupported theme option 'show_revision' given
./Documentation/Configuration/WidgetSettings.rst:13: WARNING: undefined label: widget (if the link has no caption the label must precede a section header)
./Documentation/Widgets/ListWidget.rst:47: WARNING: php:class reference target not found: ListDataProviderInterface

Associated revisions

Revision 2a01c3f7 (diff)
Added by Daniel Siepmann 2 months ago

[DOCS] Fix warnings of rendering ext:dashboard

  • Fix broken indentation
  • Add missing blank line
  • Fix wrong used reference target
  • Add missing interface to docs, which already was referenced

Resolves: #91199
Releases: master
Change-Id: If42021e0f7b4a0b879ba5be6bde9112b6c7e658d
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/64322
Tested-by: TYPO3com <>
Tested-by: Björn Jacob <>
Tested-by: Richard Haeser <>
Reviewed-by: Björn Jacob <>
Reviewed-by: Richard Haeser <>

History

#1 Updated by Daniel Siepmann 2 months ago

  • Status changed from New to Accepted

I'm in contact with Martin regarding:

WARNING: unsupported theme option 'show_sphinx' given
WARNING: unsupported theme option u'show_legalinfo' given
WARNING: unsupported theme option 'use_opensearch' given
WARNING: unsupported theme option 'show_revision' given

I see those warnings also in other extensions and expect the current Docker Image to be the source.

I'll fix the other warnings.

#2 Updated by Gerrit Code Review 2 months ago

  • Status changed from Accepted to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/64322

#3 Updated by Daniel Siepmann 2 months ago

The mentioned issues will be fixed in future version of Docker Image.
All other issues are fixed with the patch.

#4 Updated by Daniel Siepmann 2 months ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100

#5 Updated by Benni Mack 2 months ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF