Docs

.gitlab-ci.yml

@@ -11,6 +11,7 @@ image: python:latest
 stages:
   - linting
   - testing
+  - docs
 
 # Change pip's cache directory to be inside the project directory since we can
 # only cache local items.
@@ -28,27 +29,26 @@ cache:
 #    - venv/   #
 
   
-
-  
 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
-  # allow_failure: true
-  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
@@ -61,6 +61,19 @@ test:
 #    - pip install tox flake8  # you can also use tox
 #    - tox -e py36,flake8
 
+pages:
+  stage: docs
+  when: manual
+  script:
+  - pip install -U sphinx sphinx-autoapi sphinx_rtd_theme # sphinx_panels
+  - cd docs
+  - make html
+  - mv build/html/ ../public
+  artifacts:
+    paths:
+    - public
+
+
 # Commenting out all other stages and jobs
 #run:
 #  script:
@@ -72,14 +85,3 @@ test:
 #    paths:
 #      - dist/*.whl
 
-#pages:
-#  script:
-#    - pip install sphinx sphinx-rtd-theme
-#    - cd doc
-#    - make html
-#    - mv build/html/ ../public/
-#  artifacts:
-#    paths:
-#      - public
-#  rules:
-#    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

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.

docs/source/conf.py

+"""
 # Configuration file for the Sphinx documentation builder.
-#
+
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('../../plotid'))
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+from plotid import __version__, __author__  # noqa: E402
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'PlotID'
-copyright = '2022, Example Author'
-author = 'Example Author'
+project = 'plotID'
+copyright = '2022, ' + __author__
+author = __author__
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.6'
+release = __version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,6 +35,7 @@ release = '0.0.6'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.napoleon',
     'autoapi.extension'
 ]
 autoapi_type = 'python'
@@ -50,7 +55,7 @@ exclude_patterns = []
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

plotid/__init__.py

+"""
+plotID for Python.
+
+This is the python plotID project.
+plotID is a program connected to Research Data Management (RDM).
+It has two main functionalities:
+1. Tag your plot with an identifier.
+2. Export the resulting file to a specified directory along the corresponding
+research data, the plot is based on. Additionally, the script that created the
+plot will also be copied to the directory.
+"""
+
+__version__ = '0.1.0'
+__author__ = 'Institut Fluidsystemtechnik within nfdi4ing at TU Darmstadt'

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

setup.cfg

 [metadata]
 name = plotID
-version = 0.1.0
-author = Institut Fluidsystemtechnik within nfdi4ing at TU Darmstadt
+version = attr: plotid.__version__
+author = attr: plotid.__author__
 author_email = nfdi4ing@fst.tu-darmstadt.de
 description = The plotID toolkit supports researchers in tracking and storing relevant data in plots. Plots are labelled with an ID and the corresponding data is stored.
 license = Apache License, Version 2.0