diff --git a/.github/workflows/generate_docs.yml b/.github/workflows/generate_docs.yml index 9bec266..e202862 100644 --- a/.github/workflows/generate_docs.yml +++ b/.github/workflows/generate_docs.yml @@ -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 @@ -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 @@ -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"]' diff --git a/README.md b/README.md index 3a1be58..7df00f8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..6e61d51 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ + +MobilityDB icon + +----------------------------------------------- +# **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) + + diff --git a/docs/mobilitydb-workshop.xml b/docs/mobilitydb-workshop.xml index 94b0566..e27fa95 100644 --- a/docs/mobilitydb-workshop.xml +++ b/docs/mobilitydb-workshop.xml @@ -54,8 +54,6 @@ Université libre de Bruxelles, Belgium - Update contents to MobilityDB 1.1. -