Commit 9323da98 authored by Heather Ellsworth's avatar Heather Ellsworth
Browse files

Merge branch 'check-doap' into 'master'

Check the example doap file

See merge request Librem5/developer.puri.sm!28
parents b420fc0b 6f26ded4
job:
before_script:
- apt-get -y update
- apt-get -y install make python3-sphinx
- apt-get -y install make python3-sphinx libxml2-utils
tags:
- librem5
script:
......
......@@ -12,37 +12,10 @@ If you wish to own an issue, you will need additional permissions in our GitLab
Repository Guidelines
*********************
If you have a repository that you maintain but expect others to contribute to, then it is helpful for newcomers to know who to contact when they have questions regarding that repository. For this reason, we would like every repository to contain a `doap <https://en.wikipedia.org/wiki/DOAP>`_ file with the maintaner field filled out. Optionally, if you know of someone that will regularly review your merge requests, then the helper field should also be completed. For a list of supported doap fields, see `this list on Wikipedia <https://en.wikipedia.org/wiki/DOAP>`_ but below is complete example you can modify to match your project::
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">
<name>YOUR PROJECT</name>
<shortname>YOUR PROJECT</shortname>
<shortdesc>DESCRIPTION OF YOUR PROJECT</shortdesc>
<homepage rdf:resource="LINK TO CODE" />
<license rdf:resource="http://usefulinc.com/doap/licenses/gpl" />
<programming-language>LANG</programming-language>
<maintainer>
<foaf:Person>
<foaf:name>MAINTAINER'S NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:MAINTAINER'S EMAIL" />
</foaf:Person>
</maintainer>
<helper>
<foaf:Person>
<foaf:name>FREQUENT REVIEWER NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:FREQUENT REVIEWER EMAIL" />
</foaf:Person>
</helper>
</Project>
If you have a repository that you maintain but expect others to contribute to, then it is helpful for newcomers to know who to contact when they have questions regarding that repository. For this reason, we would like every repository to contain a `doap <https://en.wikipedia.org/wiki/DOAP>`_ file with the maintaner field filled out. Optionally, if you know of someone that will regularly review your merge requests, then the helper field should also be completed. For a list of supported doap fields, see `this list on Wikipedia <https://en.wikipedia.org/wiki/DOAP>`_ but below is complete example you can modify to match your project:
.. literalinclude:: examples/doap.xml
:language: XML
Be sure to adapt the above template to match your project info.
......
# Makefile for Sphinx documentation
#
XML_SOURCES = \
examples/doap.xml \
$(NULL)
# You can set these variables from the command line.
SPHINXOPTS = -W
SPHINXBUILD = sphinx-build
......@@ -49,7 +53,7 @@ clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
html: check
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
......@@ -223,3 +227,7 @@ dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
.PHONY: check
check:
xmllint --noout $(XML_SOURCES)
<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">
<name>YOUR PROJECT</name>
<shortname>YOUR PROJECT</shortname>
<shortdesc>DESCRIPTION OF YOUR PROJECT</shortdesc>
<homepage rdf:resource="LINK TO CODE" />
<license rdf:resource="http://usefulinc.com/doap/licenses/gpl" />
<programming-language>LANG</programming-language>
<maintainer>
<foaf:Person>
<foaf:name>MAINTAINER'S NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:MAINTAINER'S EMAIL" />
</foaf:Person>
</maintainer>
<helper>
<foaf:Person>
<foaf:name>FREQUENT REVIEWER NAME</foaf:name>
<foaf:mbox rdf:resource="mailto:FREQUENT REVIEWER EMAIL" />
</foaf:Person>
</helper>
</Project>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment