Create doc folder and attach auto build to CI system

.gitlab-ci.yml

@@ -2,6 +2,7 @@ stages:
   - build
   - test
   - stats
+  - doc
 
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
@@ -69,3 +70,19 @@ pylint:
   artifacts:
     paths:
       - ./pylint/
+
+
+pages:
+  image: python3.9
+  stage: doc
+  before_script:
+    - pip install sphinx==4.5.0 sphinxcontrib-apidoc==0.3.0 sphinx-rtd-theme==1.0.0 recommonmark==0.7.1 sphinxcontrib-napoleon==0.7 sphinx-autoapi==1.8.4
+  script:
+    - mkdir public
+    - cd doc && make html && cd ..
+    # - cp -r coverage_cpp/ public/coverage_cpp
+    # - mv htmlcov/ public/coverage
+    # - mv doc/_build/html/* public/
+  artifacts:
+    paths:
+      - public

doc/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/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('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pafsim'
+copyright = '2020, The pafsim developers'
+author = 'Niclas Esser, Weiwei Chen'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+        'sphinx.ext.autodoc',
+        'sphinx.ext.coverage',
+        'sphinx.ext.napoleon',
+        'sphinx_rtd_theme',
+        'recommonmark',
+        'sphinx.ext.intersphinx'
+]
+# 'sphinx.ext.viewcode',
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+#AUTOAPI
+extensions.append('autoapi.extension')
+
+autoapi_type = 'python'
+autoapi_dirs = ["../pafsim"]
+autoapi_add_toctree_entry = False
+autoapi_options = ["members", "undoc-members", "show-inheritance-diagram", "show-inheritance", "imported-members"]
+autoapi_python_use_implicit_namespaces = True
+#"show-module-summary"
+
+autoapi_ignore = ['*test*']
+autoapi_python_class_content = 'both'
+autoapi_keep_files = True
+
+
+#########################################################################
+# Intersphinx
+########################################################################
+
+intersphinx_mapping = {}
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+html_theme_options = {
+        'collapse_navigation': False,
+        'logo_only': True,
+        'display_version': False,
+}
+
+html_show_sourcelink = False
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

doc/index.rst

+:ref:`genindex`
\ No newline at end of file

pafsim/processor/generator.py

@@ -265,3 +265,4 @@ class Generator(Processor):
             plt.close()
         else:
             plt.show()
+#pylint: enable=R0801