Change docs theme to readthedocs.

.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

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.

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')