From 5938c5e619fb0280ad3c27c511f1c14e4d96ef4b Mon Sep 17 00:00:00 2001
From: "Mayr, Hannes" <hannes.mayr@stud.tu-darmstadt.de>
Date: Wed, 17 Aug 2022 14:27:10 +0200
Subject: [PATCH] Change docs theme to readthedocs.
---
.gitlab-ci.yml | 12 +++++++-----
README.md | 2 +-
plotid/example.py | 4 ++--
3 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index c45936b..94dffe1 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -32,21 +32,23 @@ cache:
before_script:
- python --version # For debugging
- pip install -r requirements.txt # install dependencies from file
- - pip install flake8
- - pip install pylint
# - pip install virtualenv
# - virtualenv venv
# - source venv/bin/activate
PEP8:
stage: linting
- script: flake8 --count . # PEP8 linting
+ script:
+ - pip install flake8
+ - flake8 --count . # PEP8 linting
Pylint:
stage: linting
# allow_failure: true
- script: find . -type f -name '*.py' | xargs pylint -rn --rcfile='plotid/.pylintrc' # Find all python files and check the code with pylint.
+ script:
+ - pip install pylint
+ - find . -type f -name '*.py' | xargs pylint -rn --rcfile='plotid/.pylintrc' # Find all python files and check the code with pylint.
test:
stage: testing
@@ -63,7 +65,7 @@ pages:
stage: docs
when: manual
script:
- - pip install -U sphinx sphinx-autoapi # sphinx_rtd_theme sphinx_panels
+ - pip install -U sphinx sphinx-autoapi sphinx_rtd_theme # sphinx_panels
- cd docs
- make html
- mv build/html/ ../public
diff --git a/README.md b/README.md
index 996605b..adda52c 100644
--- a/README.md
+++ b/README.md
@@ -99,5 +99,5 @@ If you want to build plotID yourself, follow these steps:
## Documentation
-If you have more questions about plotID, please have a look at the [documentation](link-to-docs).
+If you have more questions about plotID, please have a look at the [documentation](https://plotid.pages.rwth-aachen.de/plotid_python).
Also have a look at the example.py that is shipped with plotID.
diff --git a/plotid/example.py b/plotid/example.py
index 937e65f..7e41ff8 100644
--- a/plotid/example.py
+++ b/plotid/example.py
@@ -44,7 +44,7 @@ FIGS_AS_LIST = [FIG1, FIG2]
IMGS_AS_LIST = [IMG1, IMG2]
# Example for how to use tagplot with matplotlib figures
-[TAGGED_FIGS, ID] = tagplot('FIGS_AS_LIST', 'matplotlib', prefix=PROJECT_ID,
+[TAGGED_FIGS, ID] = tagplot(FIGS_AS_LIST, 'matplotlib', prefix=PROJECT_ID,
id_method='time', location='west')
# Example for how to use tagplot with image files
@@ -55,6 +55,6 @@ IMGS_AS_LIST = [IMG1, IMG2]
# Arguments: Source directory or files as list, destination directory, figures,
# plots or images.
-publish(['../README.md', '../dist', '../LICENSE'],
+publish(['../README.md', '../docs', '../LICENSE'],
'/home/chief/Dokumente/fst/plotid_python/data',
TAGGED_FIGS, 'Bild')
--
GitLab