Merge branch 'feature/Move-gnatfuzz-part-of-documentation' into 'master'

Insert the GNATfuzz documentation earlier

Closes eng/das/fuzz/gnatfuzz#663

See merge request eng/das/cov/gnatcoverage!360

This means it appears before the appendix, and before the section about integrating GNATtest with GNATfuzz.

Also adds a job to automatically build the docs during CI, when anything in docs/ is changed.

Fixes eng/das/fuzz/gnatfuzz#663

Author: rowan-walshe

.gitlab-ci.yml

@@ -68,6 +68,28 @@ build:
     paths:
       - $PACKAGE_BASE_NAME
 
+build_docs:
+  stage: build
+  services:
+     - image:e3
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" || ($CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH)
+      changes:
+        - doc/**/*
+      when: always
+  script:
+    - unset GITLAB_TOKEN
+    - generic_anod_ci
+    - . /tmp/ci_env.sh
+    - anod build gnatdas-doc --latest
+    - mv $ANOD_DEFAULT_SANDBOX_DIR/x86_64-linux/gnatdas-doc/install/share/doc/gnatdas/ $CI_PROJECT_DIR
+  artifacts:
+    when:
+      always
+    paths:
+      - gnatdas/pdf/gnatdas.pdf
+      - gnatdas/html
+
 build_community:
   interruptible: true
   services:

doc/Makefile

@@ -41,7 +41,7 @@ prepare-installdir.%:
 # expect to have a line like << master_doc = "bla" or 'bla' >> someplace.
 
 MASTER_DOC=$(shell sed -n -e \
-   "s/master_doc.*=[^'\"]*['\"]\([^'\"]*\).*/\1/p" conf.py)
+	"s/master_doc.*=[^'\"]*['\"]\([^'\"]*\).*/\1/p" conf.py)
 
 # Make sure the PDF we install has a meaningful name and leave the html
 # alone so internal hyperlinks to the toplevel page remain functional.
@@ -107,9 +107,9 @@ prepare-builddir.%: $(PREPARE_IMAGES)
 # bits to find it in index.rst.
 look_for_gnatfuzz:
 	if [ -e "gnatfuzz/gnatfuzz_part.rst" ]; then \
-	   if [ "`grep "gnatfuzz" index.rst`" =  "" ]; then \
-	      echo "   gnatfuzz/gnatfuzz_part" >> index.rst; \
-	   fi; \
+		if [ "`grep "gnatfuzz" index.rst`" =  "" ]; then \
+			sed -i -e 's/\.\. Optional GNATfuzz part/   gnatfuzz\/gnatfuzz_part/g' index.rst; \
+		fi; \
 	fi
 
 build.pdf: look_for_gnatfuzz prepare-builddir.pdf

doc/index.rst

@@ -8,6 +8,9 @@
 
    gnatcov/gnatcov_part
    gnattest/gnattest_part
+
+.. Optional GNATfuzz part
+
    integration/integration_part
 
 .. Appendix part - manual numbering