Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Installation guide for Gitlab Pages #590

Closed
wants to merge 5 commits into from
Closed
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion doc/usage.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,37 @@
"</div>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Automatic Creation of HTML and PDF output on GitLab Pages\n",
"\n",
"When using GitLab pages, you can use nbsphinx by adding the file `.gitlab-ci.yml` to your repo and copy the following code into this file:\n",
"```\n",
"image: python\n",
"\n",
"before_script:\n",
" - apt-get update -y\n",
" - apt-get install -y pandoc\n",
"\n",
"\n",
"pages:\n",
" stage: deploy\n",
" script:\n",
" - pip install numpy ipykernel\n",
" - pip install sphinx nbsphinx \n",
" - mkdir -p doc; cd doc\n",
" - sphinx-build -b html source ../public/\n",
" - echo 'Done'\n",
" artifacts:\n",
" paths:\n",
" - public\n",
" only:\n",
" - master\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -876,7 +907,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3",```
kolibril13 marked this conversation as resolved.
Show resolved Hide resolved
"language": "python",
"name": "python3"
},
Expand Down