Merge 29a40c2 into aa9a2c8

.readthedocs.yaml

@@ -0,0 +1,32 @@
+#
+# libzmq readthedocs.io integration
+#
+# This configuration file is processed by readthedocs.io to rebuild the
+# libzmq documentation using Asciidoctor, see
+#   https://docs.readthedocs.io/en/stable/build-customization.html#asciidoc
+
+version: "2"
+
+formats:
+  - htmlzip
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    nodejs: "20"
+  # NOTE: as of Nov 2023, build.apt_packages is NOT considered when using build.commands
+  #apt_packages:
+  #  - automake
+  #  - autoconf
+  #  - cmake
+  #  - libtool
+  commands:
+    - npm install -g asciidoctor
+    - asciidoctor --backend html --destination-dir $READTHEDOCS_OUTPUT/html --attribute zmq_version='4.3.6' doc/*.adoc
+    # we use as landing page the "zmq.html":
+    - cp $READTHEDOCS_OUTPUT/html/zmq.html $READTHEDOCS_OUTPUT/html/index.html
+    # htmlzip docs are just like HTML:
+    # NOTE: for usability we make sure zip will create a zipfile containing just a flat list of HTML files; to achieve that
+    #       it's important to avoid storing absolute paths when invoking "zip", thus we use -j
+    - mkdir -p $READTHEDOCS_OUTPUT/htmlzip/
+    - cd $READTHEDOCS_OUTPUT/html && zip -j ../htmlzip/f18m-libzmq.zip *.html

doc/Makefile.am

@@ -52,11 +52,11 @@ MAINTAINERCLEANFILES += $(HTML_DOC) $(MAN_DOC)
 SUFFIXES=.html .adoc .3 .7
 
 .adoc.html:
-	asciidoctor -b html -azmq_version=@PACKAGE_VERSION@  $<
+	asciidoctor --backend html --attribute zmq_version=@PACKAGE_VERSION@  $<
 .adoc.3:
-	asciidoctor -b manpage -azmq_version=@PACKAGE_VERSION@  $<
+	asciidoctor --backend manpage --attribute zmq_version=@PACKAGE_VERSION@  $<
 .adoc.7:
-	asciidoctor -b manpage -azmq_version=@PACKAGE_VERSION@  $<
+	asciidoctor --backend manpage --attribute zmq_version=@PACKAGE_VERSION@  $<
 
 dist-hook : $(MAN_DOC) $(HTML_DOC)