Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
PAF Backend Simulator
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
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
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
Niclas Esser
PAF Backend Simulator
Commits
82a6ea5b
Commit
82a6ea5b
authored
8 months ago
by
Niclas Esser
Browse files
Options
Downloads
Patches
Plain Diff
Install pandoc
parent
976996a1
No related branches found
Branches containing commit
No related tags found
1 merge request
!5
Doc
Pipeline
#214753
passed
8 months ago
Stage: build
Stage: test
Stage: stats
Stage: doc
Stage: deploy
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.gitlab-ci.yml
+3
-1
3 additions, 1 deletion
.gitlab-ci.yml
doc/index.rst
+12
-4
12 additions, 4 deletions
doc/index.rst
with
15 additions
and
5 deletions
.gitlab-ci.yml
+
3
−
1
View file @
82a6ea5b
...
...
@@ -76,7 +76,9 @@ pages:
image
:
python:3.9
stage
:
doc
before_script
:
-
pip3 install sphinx==7.2.6 networkx==2.5 sphinxcontrib-apidoc==0.5.0 sphinx-rtd-theme==2.0.0 Jinja2==3.0.3 recommonmark==0.6.0 nbsphinx==0.9.3 nbconvert==6.4.3 sphinxcontrib-napoleon==0.7 sphinx-autoapi==3.0.0 graphviz ipython==7.20.0 json_schema_for_humans==0.40.3 pandoc --break-system-packages
-
apt-get update
-
apt-get install -y pandoc
-
pip3 install sphinx==7.2.6 networkx==2.5 sphinxcontrib-apidoc==0.5.0 sphinx-rtd-theme==2.0.0 Jinja2==3.0.3 recommonmark==0.6.0 nbsphinx==0.9.3 nbconvert==6.4.3 sphinxcontrib-napoleon==0.7 sphinx-autoapi==3.0.0 graphviz ipython==7.20.0 json_schema_for_humans==0.40.3 --break-system-packages
script
:
-
mkdir public
-
make -C doc/ html
...
...
This diff is collapsed.
Click to expand it.
doc/index.rst
+
12
−
4
View file @
82a6ea5b
...
...
@@ -12,21 +12,29 @@ Installation
It is recommended to create a virtual environment before installing the package.
`python -m venv /path/to/venv/`
.. code-block:: bash
python -m venv /path/to/venv/
Activate the venv
`source /path/to/venv/bin/activate`
.. code-block:: bash
source /path/to/venv/bin/activate`
The project is managed by the `pyproject.toml`-file. Hence, an installation with `pip` is the prefered way.
In the next step we clone the pafsim repository:
`git clone https://gitlab.mpcdf.mpg.de/nesser/pafsim && cd pafsim`
.. code-block:: bash
git clone https://gitlab.mpcdf.mpg.de/nesser/pafsim && cd pafsim
and install it
`pip install .`
.. code-block:: bash
pip install .
All required dependencies are resolved.
...
...
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