docs: update build procedure and fix warning

Build api docs in conf.py so it is all in one place for readthedocs
to make use of.

Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>

.readthedocs.yml

@@ -23,3 +23,5 @@ python:
   install:
     - requirements: requirements.txt
     - requirements: requirements-dev.txt
+    - method: pip
+      path: .

Makefile

@@ -39,7 +39,6 @@ coverage: ## Run pytest with coverage report.
 docs: ## Generate documentation.
 	rm -f docs/craft_store.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ craft_store --no-toc --ext-githubpages
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 

craft_store/store_client.py

@@ -18,20 +18,17 @@
 
 import base64
 import json
-from typing import TYPE_CHECKING, Any, Dict, Sequence
+from typing import Any, Dict, Sequence
 from urllib.parse import urlparse
 
 import requests
 from macaroonbakery import bakery, httpbakery
 from pymacaroons.serializers import json_serializer
 
-from . import errors
+from . import endpoints, errors
 from .auth import Auth
 from .http_client import HTTPClient
 
-if TYPE_CHECKING:
-    from . import endpoints
-
 
 def _macaroon_to_json_string(macaroon) -> str:
     return macaroon.serialize(json_serializer.JsonSerializer())
@@ -78,14 +75,14 @@ def __init__(
         self,
         *,
         base_url: str,
-        endpoints: "endpoints.Endpoints",
+        endpoints: endpoints.Endpoints,
         application_name: str,
         user_agent: str,
     ) -> None:
         """Initialize the Store Client.
 
         :param base_url: the base url of the API endpoint.
-        :param endpoints: :data:`endpoints.CHARMHUB` or :data:`endpoints.SNAP_STORE`.
+        :param endpoints: :data:`.endpoints.CHARMHUB` or :data:`.endpoints.SNAP_STORE`.
         :param application_name: the name application using this class, used for the keyring.
         :param user_agent: User-Agent header to use for HTTP(s) requests.
         """

docs/conf.py

@@ -91,3 +91,18 @@
 
 # Enable support for google-style instance attributes.
 napoleon_use_ivar = True
+
+
+def run_apidoc(_):
+    from sphinx.ext.apidoc import main
+    import os
+    import sys
+
+    sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+    cur_dir = os.path.abspath(os.path.dirname(__file__))
+    module = os.path.join(cur_dir, "..", "craft_store")
+    main(["-e", "-o", cur_dir, module, "--no-toc", "--force"])
+
+
+def setup(app):
+    app.connect("builder-inited", run_apidoc)