organicmaps/libexpat
13
Fork 0
mirror of https://github.com/libexpat/libexpat.git synced 2025-04-05 05:05:00 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 1

Merge pull request #477 from libexpat/doc-ensure-valid-xml

Browse source 
Make CI ensure well-formed and valid XML in our XML-based documentation
This commit is contained in:
Sebastian Pipping 2021-05-07 18:24:26 +02:00 • committed by GitHub
commit 9d425466b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 68 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
.github/workflows/valid-xml.yml vendored Normal file
View file

@ -0,0 +1,56 @@
# __ __ _
# ___\ \/ /_ __ __ _| |_
# / _ \\ /| '_ \ / _` | __|
# | __// \| |_) | (_| | |_
# \___/_/\_\ .__/ \__,_|\__|
# |_| XML parser
#
# Copyright (c) 2021 Sebastian Pipping <sebastian@pipping.org>
# Licensed under the MIT license:
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to permit
# persons to whom the Software is furnished to do so, subject to the
# following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
# USE OR OTHER DEALINGS IN THE SOFTWARE.
name: Ensure well-formed and valid XML
on:
pull_request:
push:
schedule:
- cron: '0 2 * * 5' # Every Friday at 2am
jobs:
checks:
name: Ensure well-formed and valid XML
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2.3.4
- name: Install build dependencies
run: |-
sudo apt-get install --yes --no-install-recommends -V \
docbook \
libxml2-utils \
w3c-sgml-lib
- name: Ensure well-formed and valid XML
run: |
set -x
xmllint --noout --valid expat/doc/reference.html
xmllint --noout --valid expat/doc/xmlwf.xml

4
expat/doc/reference.html
View file

@ -2486,10 +2486,10 @@ have been allocated by <code><a href="#XML_MemMalloc"
<hr />
<footer>
<div class="footer">
Found a bug in the documentation?
<a href="https://github.com/libexpat/libexpat/issues">Please file a bug report.</a>
</footer>
</div>
</div>
</body>

6
expat/doc/style.css
View file

@ -49,3 +49,9 @@ dl dt:nth-child(1n+2) {
.cpp-symbols dt {
font-family: monospace;
}
/* Resemble style of <footer> which is not part of xhtml1-strict */
.footer {
font-size: var(--ok-fs-5);
color: var(--ok-tc-1);
}

7
expat/doc/xmlwf.xml
View file

@ -1,4 +1,5 @@
<!DOCTYPE refentry [
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Scott</firstname>">
<!ENTITY dhsurname "<surname>Bronson</surname>">
@ -49,11 +50,11 @@
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<option>-h</option>
<arg choice="plain"><option>-h</option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<option>-v</option>
<arg choice="plain"><option>-v</option></arg>
</cmdsynopsis>
</refsynopsisdiv>