Skip to content
Snippets Groups Projects
Commit 818f9c2d authored by Martin Teichmann's avatar Martin Teichmann
Browse files

Move documentation to gitlab pages

See merge request !318
parents 335dfdf1 bdee2918
No related branches found
No related tags found
1 merge request!318Pages
Pipeline #164626 failed
make: # The Docker image that will be used to build your app
image: sphinxdoc/sphinx image: sphinxdoc/sphinx
script: # Functions that should be executed before the build script is run
- apt-get update before_script: []
- apt-get install -y pandoc pages:
- apt-get install -y openssh-client script:
- pip3 install sphinx-rtd-theme - make html
- pip3 install sphinx-autoapi artifacts:
- pip3 install nbsphinx paths:
- cd doc # The folder that contains the files to be exposed at the Page URL
- make html - public
- eval $(ssh-agent) rules:
- echo "$SSHKEY" | ssh-add - # This ensures that only pushes to the default branch will trigger
- ssh -o UserKnownHostsFile=known_hosts wp86team@exflqr30526 "./doc-prepare toolbox/$CI_COMMIT_REF_NAME" # a pages deploy
- scp -o UserKnownHostsFile=known_hosts -r _build/html wp86team@exflqr30526:html/toolbox/$CI_COMMIT_REF_NAME - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
Documentation Documentation
############# #############
Online documentation can be found at `ReadTheDocs <https://rtd.xfel.eu/docs/scs-toolbox/en/latest/>`_. Online documentation can be found `here <https://scs.pages.xfel.eu/toolbox/>`_.
From within the XFEL office network, documentation for the git branches may be found `here <http://exflqr30526.desy.de:8000/toolbox/>`_.
\ No newline at end of file
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR = public
# Put it first so that "make" without argument is like "make help". # Put it first so that "make" without argument is like "make help".
help: help:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment