Skip to content

Commit

Permalink
Generate documentation automatically
Browse files Browse the repository at this point in the history
  • Loading branch information
estebanzimanyi committed Sep 20, 2023
1 parent b58c567 commit 52a0b83
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/generate_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ jobs:
cd docs
dblatex -s texstyle.sty mobilitydb-workshop.xml
dbtoepub -o mobilitydb-workshop.epub mobilitydb-workshop.xml
mkdir html
xsltproc --stringparam html.stylesheet "docbook.css" --stringparam chunker.output.encoding "UTF-8" --xinclude -o html/index.html /usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl mobilitydb-workshop.xml
cp images html/
# store the documentation files
- name: Upload Output Directory
Expand Down Expand Up @@ -64,6 +66,6 @@ jobs:
branch: gh-pages
add: '["docs/mobilitydb-workshop.pdf",
"docs/mobilitydb-workshop.epub",
"docs/docbook.css", "docs/images/*",
"docs/*.html"]'
"docs/html/docbook.css", "docs/html/images/*",
"docs/html/*.html"]'

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ of the modules.
You can generate the workshop documentation from the sources. Go to `/doc` directory and run:
* In HTML format
```bash
xsltproc --stringparam html.stylesheet "docbook.css" --xinclude -o index.html /usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl mobilitydb-workshop.xml
xsltproc --stringparam html.stylesheet "docbook.css" --stringparam chunker.output.encoding "UTF-8" --xinclude -o index.html /usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl mobilitydb-workshop.xml
```
* In PDF format
```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/mobilitydb-workshop.xml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
While this workshop illustrates the usage of MobilityDB functions, it does not explain them in detail. If you need help concerning the functions of MobilityDB, please refer to the <ulink url="https://docs.mobilitydb.com/nightly/">documentation</ulink>.
</para>
<para>
If you have questions, ideas, comments, etc., please contact me on <ulink url="mailto:mahmoud.sakr@ulb.ac.be">mahmoud.sakr@ulb.ac.be</ulink>.
If you have questions, ideas, comments, etc., please contact me on <ulink url="mailto:[email protected]">[email protected]</ulink>.
</para>
<para>
<inlinemediaobject>
Expand Down

0 comments on commit 52a0b83

Please sign in to comment.