Merge pull request #10 from highcharts-for-python/enhancement/add-documentation

Added documentation

Author: hcpchris

.readthedocs.yaml

@@ -14,14 +14,16 @@ build:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
+  apt_packages:
+    - graphviz
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: docs/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
+formats:
+   - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:

.travis.yml

@@ -9,16 +9,24 @@ job:
     #    - TOXENV=py39
     - python: "3.10"
       dist: focal
-      env: TOXENV=py310
+      env: 
+        - TOXENV=py310
+        - YARN_GPG=no
     - python: "3.11"
       dist: bionic
-      env: TOXENV=py311
+      env: 
+        - TOXENV=py311
+        - YARN_GPG=no
     - python: "3.10"
       dist: focal
-      env: TOXENV=coverage
+      env: 
+        - TOXENV=coverage
+        - YARN_GPG=no
     - python: "3.10"
       dist: focal
-      env: TOXENV=docs
+      env: 
+        - TOXENV=docs
+        - YARN_GPG=no
 os:
   - linux
 git:
@@ -29,6 +37,6 @@ install:
 before_script:
   - curl -Os --retry 5 https://uploader.codecov.io/latest/linux/codecov
   - chmod +x codecov
-script: tox -- -v -nauto 
+script: tox -- -v -n auto
 after_success:
   - if [[ -e .coverage ]]; then ./codecov -t $CODECOV_TOKEN; fi

docs/Makefile

@@ -0,0 +1,20 @@
+# 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)