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 21, 2023
1 parent 1a6784c commit 9f910c5
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 9 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/generate_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ jobs:
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 -r images html/
cp -r images docbook.css html/
cp docbook.css html/
# store the documentation files
- name: Upload Output Directory
- name: Upload output directory
uses: actions/upload-artifact@v2
with:
name: doc-files
Expand All @@ -52,7 +53,7 @@ jobs:
ref: gh-pages

# download the doc files, most of which are generated above
- name: Download Output Directory
- name: Download output directory
uses: actions/download-artifact@v2
with:
name: doc-files
Expand All @@ -64,7 +65,8 @@ jobs:
with:
message: 'Update docs'
branch: gh-pages
add: '["docs/mobilitydb-workshop.pdf",
add: '["docs/index.md",
"docs/mobilitydb-workshop.pdf",
"docs/mobilitydb-workshop.epub",
"docs/html/docbook.css", "docs/html/images/*",
"docs/html/*.html"]'
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ You can generate the workshop documentation from the sources. Go to `/doc` direc
```
In addition, pre-generated versions of them are available.

* In HTML format: https://docs.mobilitydb.com/MobilityDB-workshop/master/
* In PDF format: https://docs.mobilitydb.com/MobilityDB-workshop/master/mobilitydb-workshop.pdf
* In EPUB format: https://docs.mobilitydb.com/MobilityDB-workshop/master/mobilitydb-workshop.epub
* In HTML format: https://mobilitydb.github.io/MobilityDB-workshop/html/index.html
* In PDF format: https://mobilitydb.github.io/MobilityDB-workshop/mobilitydb-workshop.pdf
* In EPUB format: https://mobilitydb.github.io/MobilityDB-workshop/mobilitydb-workshop.epub

## How the Repo is Organized
- `/data`: raw data files used for some workshops
Expand Down
20 changes: 20 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

<img src="https://MobilityDB.github.io/MobilityDB-workshop/html/images/mobilitydb-logo.png"
alt="MobilityDB icon"
style="float: center; margin-right: 10px;" />

-----------------------------------------------
# **Documentation of the MobilityDB Workshop **
-----------------------------------------------

-----------------------------
## **Version 1.1**
-----------------------------

The documentation is available in the following formats

* [PDF](https://MobilityDB.github.io/MobilityDB-workshop/mobilitydb-workshop.pdf)
* [EPUB](https://MobilityDB.github.io/MobilityDB-workshop/mobilitydb-workshop.epub)
* [HTML](https://MobilityDB.github.io/MobilityDB-workshop/index.html)


2 changes: 0 additions & 2 deletions docs/mobilitydb-workshop.xml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@
<affiliation>
<orgname>Universit&eacute; libre de Bruxelles, Belgium</orgname>
</affiliation>
<contrib>Update contents to MobilityDB 1.1.
</contrib>
</othercredit>

<abstract>
Expand Down

0 comments on commit 9f910c5

Please sign in to comment.