elixir-cloud-aai / foca

Opinionated Flask microservice archetype for quick OpenAPI-based microservice development
Apache License 2.0
16 stars 12 forks source link

bug: Read the Docs build fails #151

Closed uniqueg closed 2 years ago

uniqueg commented 2 years ago

When trying to build API documentation to be hosted on Read the Docs, the Sphinx config imports the __version__ string. But since it resides in foca/__init__.py, together with a convenience import, it tries to import pretty much the entire app ... and fails.

To resolve the issue, store the __version__ string outside of foca/__init__.py along the lines described here: https://stackoverflow.com/questions/458550/standard-way-to-embed-version-into-python-package