Merge branch 'deploy-pages' into 'master'

Deploy pages

See merge request acs/public/simulation/dpsim!144

Former-commit-id: db92a052

.gitlab-ci.yml

@@ -89,24 +89,24 @@ build:windows:
 #  tags:
 #    - mac
 
-test:pytest:
-  stage: test
-  variables:
-    PYTHONPATH: "build/Source/Python:Source/Python"
-  script:
-    - pytest -v Examples/CIM/test_CIM.yml
-    - pytest -v Examples/Cxx/test_Circuits.yml
-    - pytest -v Examples/Cxx/test_RealTime.yml
-    #- pytest -v Examples/Cxx/test_Shmem.yml
-    - pytest -v Examples/Python/Base
-    - pytest -v Examples/Python/Circuits
-    - pytest -v Examples/Python/RealTime
-    #- pytest -v Examples/Python/Shmem
-  image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG_DEV}
-  dependencies:
-    - build:linux
-  tags:
-    - docker
+#test:pytest:
+#  stage: test
+#  variables:
+#    PYTHONPATH: "build/Source/Python:Source/Python"
+#  script:
+#    - pytest -v Examples/CIM/test_CIM.yml
+#    - pytest -v Examples/Cxx/test_Circuits.yml
+#    - pytest -v Examples/Cxx/test_RealTime.yml
+#    #- pytest -v Examples/Cxx/test_Shmem.yml
+#    - pytest -v Examples/Python/Base
+#    - pytest -v Examples/Python/Circuits
+#    - pytest -v Examples/Python/RealTime
+#    #- pytest -v Examples/Python/Shmem
+#  image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG_DEV}
+#  dependencies:
+#    - build:linux
+#  tags:
+#    - docker
 
 generate:docs:
   stage: generate
@@ -172,6 +172,24 @@ test:jupyter:
     paths:
       - outputs/Examples/Notebooks/
 
+# Stage deploy
+##############################################################################
+pages:
+  stage: deploy
+  script:
+    - cp -r build/Documentation/html/. public
+    - cp -r build/Documentation/Cxx/html/. public/cxx
+  artifacts:
+    paths:
+      - public
+  dependencies:
+    - generate:docs
+  only:
+    - master
+  tags:
+    - shell
+    - linux
+
 deploy:docker:
   stage: deploy
   script:
@@ -187,22 +205,6 @@ deploy:docker:
   only:
     - tags
 
-deploy:docs:
-  stage: deploy
-  script:
-    - ssh ${DEPLOY_USER}@${DEPLOY_HOST} mkdir -p ${DEPLOY_PATH}/doc/${CI_BUILD_REF_NAME}/{sphinx,doxygen}
-    - rsync ${RSYNC_OPTS} --delete build/Documentation/html/ ${DEPLOY_USER}@${DEPLOY_HOST}:${DEPLOY_PATH}/doc/${CI_BUILD_REF_NAME}/sphinx
-    - rsync ${RSYNC_OPTS} --delete build/Documentation/Cxx/html/ ${DEPLOY_USER}@${DEPLOY_HOST}:${DEPLOY_PATH}/doc/${CI_BUILD_REF_NAME}/doxygen
-  dependencies:
-    - generate:docs
-  only:
-    - tags
-    - deploy
-  tags:
-    - fein-deploy
-    - shell
-    - linux
-
 deploy:packages:
   stage: deploy
   script:

Documentation/Doxyfile.in.REMOVED.git-id

-098ac7c86fb9cb1fe4c8bae683bf1059ef1f866f
\ No newline at end of file

Documentation/Index.rst → Documentation/about.rst

@@ -6,6 +6,9 @@
 DPsim
 ======
 
+.. meta::
+   :generator: GitLab Pages
+
 DPsim is a solver library for power system simulation.
 
 - It supports both the electro-magnetic transient (EMT) and dynamic phasor (DP) domain.

Documentation/conf.py.in

@@ -48,7 +48,7 @@ templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'Index'
+master_doc = 'about'
 
 # General information about the project.
 project = '@PROJECT_NAME@'

README.md

 # <img src="Documentation/images/dpsim.png" width=40 /> DPsim
 
-[![build status](https://git.rwth-aachen.de/acs/public/simulation/dpsim/badges/master/build.svg)](https://git.rwth-aachen.de/acs/core/simulation/dpsim/commits/master)
-[![coverage report](https://git.rwth-aachen.de/acs/public/simulation/dpsim/badges/master/coverage.svg)](https://git.rwth-aachen.de/acs/core/simulation/dpsim/commits/master)
+[![build status](https://git.rwth-aachen.de/acs/public/simulation/dpsim/badges/master/build.svg)](https://git.rwth-aachen.de/acs/public/simulation/dpsim/commits/master)
+[![coverage report](https://git.rwth-aachen.de/acs/public/simulation/dpsim/badges/master/coverage.svg)](https://git.rwth-aachen.de/acs/public/simulation/dpsim/commits/master)
 
 DPsim is a solver library for power system simulation.
 
@@ -9,23 +9,23 @@ DPsim is a solver library for power system simulation.
 - It provides a Python module which can be embedded in any Python 3 application / scripts.
 - It is implemented in highly-efficient C++ code.
 - It supports real-time execution with time-steps up to 50 uS.
-- It can load models in the [Common Information Model (CIM)](https://en.wikipedia.org/wiki/Common_Information_Model_%28electricity%29) XML format.
+- It can load models in the IEC61970 Common Information Model (CIM) XML format.
 - It can be interfaced to a variety of protocols and interfaces via [VILLASnode](http://www.fein-aachen.org/projects/villas-framework/).
 
 ## Installation
-If you just want to use DPsim for simulations, take a look at the [installation instructions](https://dpsim.fein-aachen.org/doc/master/sphinx/Install.html).
+If you just want to use DPsim for simulations, take a look at the [installation instructions](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/Install.html).
 
-If you would like to modify / extend DPsim or build it for a specific platform, take a look at the [build instructions](https://dpsim.fein-aachen.org/doc/master/sphinx/Build.html).
+If you would like to modify / extend DPsim or build it for a specific platform, take a look at the [build instructions](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/Build.html).
 
 ## Usage
 DPsim is a Python extension module which is implemented in optimized native C++ code. 
-Users can control and script the simulation with Python scripts. Checkout the [Examples](https://dpsim.fein-aachen.org/doc/master/sphinx/Examples.html).
+Users can control and script the simulation with Python scripts. Checkout the [Examples](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/Examples.html).
 
 ## Documentation
 
-The [user documentation](http://dpsim.fein-aachen.org/doc/master/sphinx/) has examples, build / installation instructions and covers the Python API.
+The [user documentation](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/about.html) has examples, build / installation instructions and covers the Python API.
 
-The C++ [developer documentation](http://dpsim.fein-aachen.org/doc/master/doxygen/) only includes automatically generated content using Doxygen.
+The C++ [developer documentation](https://acs.pages.rwth-aachen.de/public/simulation/dpsim/cxx/index.html) only includes automatically generated content using Doxygen.
 It is helpful to understand the general structure of the C++ DPsim core components.
 
 ## Copyright
@@ -34,7 +34,7 @@ It is helpful to understand the general structure of the C++ DPsim core componen
 
 ## License
 
-This project is released under the terms of the [GPL version 3](https://dpsim.fein-aachen.org/doc/master/sphinx/Copying.html).
+This project is released under the terms of the [GPL version 3](https://git.rwth-aachen.de/acs/public/simulation/dpsim/blob/master/COPYING.md).
 
 ```
 This program is free software: you can redistribute it and/or modify

public/index.html

+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="generator" content="GitLab Pages">
+  </head>
+  <body>
+    <p>
+      Follow the link to the DPsim <a href="https://acs.pages.rwth-aachen.de/public/simulation/dpsim/about.html">Sphinx documentation</a> or <a href="https://acs.pages.rwth-aachen.de/public/simulation/dpsim/cxx/index.html">Doxygen documentation</a>.
+    </p>
+  </body>
+</html>
+