docs: Symlink (instead of copying) the API reference

[ upstream commit 944dddf ]

To generate the gRPC API reference, we copy the "api" repository at the
root of the repository to "Documentation/_api". This step is required
everywhere we need to build the docs:

  - Locally, we run it through the "copy-api" target in
    Documentation/Makefile, before generating the HTML.
  - Same thing for the Netlify preview, where "copy-api" is a dependency
    for the "html-netlify" target.
  - However, on ReadTheDocs, where we generate and host the online
    documentation, we do not perform this step; nor do we use the
    Makefile at all.

As a workaround, let's simplify the way we access the API reference.
Instead of copying the docs, just symlink them from the Documentation
directory.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>

.github/workflows/documentation.yaml

@@ -56,9 +56,6 @@ jobs:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
         with:
           persist-credentials: false
-      - name: Run pre-requisites for validation
-        run: |
-          make -C Documentation copy-api # necessary for check-build.sh
       - uses: docker://cilium/docs-builder:2023-03-01@sha256:36b233afd73482c2bc7ed43f7a1537f09962015c34679b86c4ca1fa618d67b95
         with:
           entrypoint: ./Documentation/check-build.sh

Documentation/.gitignore

@@ -1,5 +1,4 @@
 _build
-_api
 _preview
 _exts/__pycache__
 Pipfile

Documentation/Makefile

@@ -77,10 +77,6 @@ ifeq ($(V),0)
 SPHINX_OPTS += -q
 endif
 
-copy-api:
-	@$(ECHO_GEN)_api
-	$(QUIET)cp -r ../api/. _api
-
 update-helm-values: $(HELM_VALUES) ## Update the Helm reference documentation.
 
 HELM_DOCS_ROOT_PATH := $(DOCKER_CTR_ROOT_DIR)
@@ -101,11 +97,11 @@ $(HELM_VALUES): FORCE
 	$(QUIET)printf '..\n  %s\n\n%s\n' "AUTO-GENERATED. Please DO NOT edit manually." "$$(cat $@)" > $@
 	$(QUIET)$(RM) -- $(TMP_FILE_1) $(TMP_FILE_2)
 
-epub latex html: builder-image copy-api update-helm-values ## Check documentation and render it under the specified format.
+epub latex html: builder-image update-helm-values ## Check documentation and render it under the specified format.
 	@$(ECHO_GEN)_build/$@
 	$(QUIET)$(DOCKER_RUN) ./check-build.sh $(@) $(SPHINX_OPTS)
 
-html-netlify: copy-api
+html-netlify:
 	@$(ECHO_GEN)_build/$@
 	$(QUIET) SKIP_LINT=1 ./check-build.sh html $(SPHINX_OPTS)
 

Documentation/_api

@@ -0,0 +1 @@
+../api