Docs build in google-cloud-documentai fails with list starting with an unexpected section title #1779
Description
I had to manually fix a google-cloud-python PR that had a comment looking like this:
Currently support query strings are:
------------------------------------
``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``
- ``LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED``
- ``DisplayName=\"file_name.pdf\"``
- ``EntityType=abc/def``
The docs build failed because of Unexpected section title as a result of HTML syntax not supported. There was also a missing hyphen in the first bullet point and extra whitespace.
Sphinx expects this:
Currently support query strings are:
- ``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``
- ``LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED``
- ``DisplayName=\"file_name.pdf\"``
- ``EntityType=abc/def``