API: Add cross-linking to common-api

Now that we depend on common-api v0.3.x+ we can cross-link the
documentation.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -20,7 +20,6 @@
 
 ### Cookiecutter template
 
-
 - Generated project's dependencies were bumped.
 
 - Move `TODO`s so they are in their own line.
@@ -41,6 +40,8 @@
 
   This is just to be nice to most editors and text files conventions, that likes it more if there is a `\n` at the end of the file.
 
+- API: The common-api documentation now is cross-linked.
+
 ## Bug Fixes
 
 <!-- Here goes notable bug fixes that are worth a special mention or explanation -->

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

@@ -114,6 +114,7 @@ plugins:
             - https://frequenz-floss.github.io/frequenz-channels-python/v0.14/objects.inv
             - https://frequenz-floss.github.io/frequenz-sdk-python/v0.22/objects.inv
 {%- elif cookiecutter.type == "api" %}
+            - https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
             - https://grpc.github.io/grpc/python/objects.inv
 {%- endif %}
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml

@@ -110,6 +110,7 @@ plugins:
             # TODO(cookiecutter): You might want to add other external references here
             # See https://mkdocstrings.github.io/python/usage/#import for details
             - https://docs.python.org/3/objects.inv
+            - https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
             - https://grpc.github.io/grpc/python/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search