Merge pull request #5 from guiferviz/t30

Testing docs generation: diagrams are different from local

.github/workflows/docs_check.yml

@@ -18,6 +18,10 @@ jobs:
         sudo apt-get install graphviz
         pip install -r requirements_dev.in
     - name: Generate pre-build data
-      run: cd doc/ && make generate_data
+      run: |
+        cd doc/
+        make generate_data
     - name: Build docs
-      run: cd doc/ && make html
+      run: |
+        cd doc/
+        make html

.github/workflows/python_package.yml

@@ -40,7 +40,7 @@ jobs:
       # It was impossible for me to upload parallel versions and
       # merge them at the end. Errors everywhere.
       # For the moment I'm going to upload only the 3.8 coverage.
-      if: matrix.python-version == '3.8'
+      if: matrix.python-version == '3.8'  # double quotes do not work here...
       run: |
         coveralls debug
         coveralls

doc/Makefile

@@ -8,6 +8,8 @@ SPHINXAPIDOC  = sphinx-apidoc
 SOURCEDIR     = .
 BUILDDIR      = _build
 
+# DOC_DIR = current Makefile dir
+DOC_DIR=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 GENERATED_DIR=_generated
 GENERATED_FILES=$(GENERATED_DIR)/classes.png $(GENERATED_DIR)/classes.pdf $(GENERATED_DIR)/packages.pdf $(GENERATED_DIR)/packages.png $(GENERATED_DIR)/recipipe_aliases.csv 
 
@@ -21,10 +23,12 @@ $(GENERATED_FILES): ../recipipe/
 	# Generate recipipe_alises.csv all.
 	python ./recipipe_aliases_generator.py $(GENERATED_DIR)/recipipe_aliases.csv
 	# Generate class and package diagram.
-	pyreverse ../recipipe -o png -k
-	pyreverse ../recipipe -o pdf -f ALL -A
-	mv classes.* $(GENERATED_DIR)
-	mv packages.* $(GENERATED_DIR)
+	# pyreverse should be used in the root, if you use 'pyreverse ../recipipe'
+	# the generated diagram is not correct (a lot of missing connections).
+	cd .. && pyreverse recipipe -o png -k
+	cd .. && pyreverse recipipe -o pdf -f ALL -A
+	cd .. && mv classes.* $(DOC_DIR)/$(GENERATED_DIR)
+	cd .. && mv packages.* $(DOC_DIR)/$(GENERATED_DIR)
 
 generate_data: $(GENERATED_FILES)