[tor-commits] [sbws/master] Include target to build diagrams

[pastly@xxxxxxxxxxxxxx]

commit c3264df50c685da7dd0160a51efced5b8e2b5690
Author: juga0 <juga@xxxxxxxxxx>
Date:   Thu Jul 5 20:23:55 2018 +0000

    Include target to build diagrams
---
 docs/Makefile | 13 +++++++++++++
 setup.py      |  2 +-
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/docs/Makefile b/docs/Makefile
index 66feed2..eee14f8 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,6 +7,12 @@ SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = simple-bw-scanner
 SOURCEDIR     = source
 BUILDDIR      = build
+# generate SVG
+IMAGEDIRS       = $(SOURCEDIR)/images
+BUILDDIRIMAGES  = $(BUILDDIR)/html/_images
+PYREVERSE     = pyreverse
+PYREVERSE_FLAGS = -o svg -p sbws ../sbws
+UMLSVG := $(PYREVERSE) $(PYREVERSE_FLAGS);mv *.svg $(IMAGEDIRS);mkdir -p $(BUILDDIRIMAGES);cp $(IMAGEDIRS)/*.svg $(BUILDDIRIMAGES)
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -14,7 +20,14 @@ help:
 
 .PHONY: help Makefile
 
+umlsvg:
+	@echo "Generating UML SVG"
+	$(UMLSVG)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	# commented because if system packages invoke make html, it'll automatically
+	# recreate the svg on every build, and it's not deterministic.
+	#$(UMLSVG)
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/setup.py b/setup.py
index b7be0f7..738be70 100755
--- a/setup.py
+++ b/setup.py
@@ -82,6 +82,6 @@ setup(
         'dev': ['flake8'],
         'test': ['tox', 'pytest', 'coverage'],
         # recommonmark: to make sphinx render markdown
-        'doc': ['sphinx', 'recommonmark'],
+        'doc': ['sphinx', 'recommonmark', 'pylint'],
     },
 )



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits