API Specification Docs not loading

[cw00dw0rd]

API Spec information is no longer loading in the documentation: https://docs.python-arango.com/en/main/specs.html

[joowani]

Found the root cause: https://readthedocs.org/api/v2/build/18769216.txt

WARNING: autodoc: failed to import module 'exceptions' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import module 'errno' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'client.ArangoClient' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'database.AsyncDatabase' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'job.AsyncJob' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'aql.AQL' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'aql.AQLQueryCache' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'backup.Backup' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'database.BatchDatabase' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'job.BatchJob' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'cluster.Cluster' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'collection.Collection' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'cursor.Cursor' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'http.DefaultHTTPClient' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'collection.EdgeCollection' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'foxx.Foxx' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'graph.Graph' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'http.HTTPClient' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'pregel.Pregel' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'replication.Replication' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'request.Request' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'response.Response' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'collection.StandardCollection' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'database.StandardDatabase' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'database.TransactionDatabase' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'collection.VertexCollection' from module 'arango'; the following exception was raised:
No module named 'arango.version'
WARNING: autodoc: failed to import class 'wal.WAL' from module 'arango'; the following exception was raised:
No module named 'arango.version'

It's the recent addition that's breaking the sphinx build:

from arango.version import __version__

We will have to find another way to get the version after all @tjoubert

[joowani]

For now the dev one works: https://docs.python-arango.com/en/dev/

[tjoubert]

@joowani , setuptools_scm says this about retrieving package version at runtime:
https://github.com/pypa/setuptools_scm#retrieving-package-version-at-runtime
Looks like we'll have to consider using importlib.metadata. What do you think?

[joowani]

Yes I think we have to go with importlib.metadata. Thanks for the quick temp PR.

[joowani]

The link you provided actually covers sphinx (our doc) also so I think we can just follow that: https://github.com/pypa/setuptools_scm#usage-from-sphinx

[tjoubert]

@joowani , so we have to do this:

from importlib_metadata import version, PackageNotFoundError

name = "python-arango"
driver_version = version(name)

Do you think it will work referencing the python-arango inside that package itself? The documentation seems to be referring to external packages that have been referenced/imported.

[joowani]

I'm not sure but you can test it out by running:

python -m sphinx -b html -W docs docs/_build