Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
ToolBox
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SCS
ToolBox
Commits
818f9c2d
Commit
818f9c2d
authored
1 month ago
by
Martin Teichmann
Browse files
Options
Downloads
Plain Diff
Move documentation to gitlab pages
See merge request
!318
parents
335dfdf1
bdee2918
No related branches found
No related tags found
1 merge request
!318
Pages
Pipeline
#164626
failed
1 month ago
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.gitlab-ci.yml
+15
-16
15 additions, 16 deletions
.gitlab-ci.yml
README.rst
+1
-3
1 addition, 3 deletions
README.rst
doc/Makefile
+1
-1
1 addition, 1 deletion
doc/Makefile
with
17 additions
and
20 deletions
.gitlab-ci.yml
+
15
−
16
View file @
818f9c2d
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
This diff is collapsed.
Click to expand it.
README.rst
+
1
−
3
View file @
818f9c2d
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
This diff is collapsed.
Click to expand it.
doc/Makefile
+
1
−
1
View file @
818f9c2d
...
@@ -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
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment