Remove load_documentation_profile which not used anymore #6231
Conversation
|
|
||
| # # we call this to make sure the ORM metadata is fully populated, | ||
| # # so that ORM models can be properly documented | ||
| # get_orm_metadata() |
There was a problem hiding this comment.
I am not sure how this is used, I found there is a similar model implementation for sqlite_temp storage, how to get orm metadata from it?
There was a problem hiding this comment.
This would be done implicitly by loading the storage backend, i.e., get_manager().get_profile_storage(). But apparently the docs build is passing without it, so it is no longer necessary it seems.
There was a problem hiding this comment.
I wonder if even need this load_documentation_profile at all anymore. This may be a relic from before v2.0 when we still had a Django backend as well which required the database to be loaded on import. This is no longer the case, so I think we can just import without having access to a profile storage. Could you try removing the load_documentation_profile call from the docs/source/conf.py file and see if the docs still build? If the case, we can just get rid of this function entirely.
There was a problem hiding this comment.
It is also called by pre-commit through python ./utils/validate_consistency.py verdi-autodocs, and that is where the verdi doc generated I assume.
There was a problem hiding this comment.
Yes, but I think you can also remove it there, it doesn't need it anymore I think
There was a problem hiding this comment.
Seems you still need this part in the conf.py:
# imports required for docs/source/reference/api/public.rst
from aiida import ( # pylint: disable=unused-import
cmdline,
common,
engine,
manage,
orm,
parsers,
plugins,
schedulers,
tools,
transports,
)
from aiida.cmdline.params import arguments, options # pylint: disable=unused-importApparently still need explicit import to have the autoapi work properly.
There was a problem hiding this comment.
Seems it should be there, otherwise, the doc build will failed with the module not being found.
There was a problem hiding this comment.
Seems the profile is needed to build the apidoc.
There was a problem hiding this comment.
I am really confused though, because it is speaking of process.aiida which is the temp profile that was created for running the howto/archive_profile.md notebook. It is a bit of a coincidence that we just fixed things there. I just merged that PR, so maybe you can rebase this PR and see if it still fails.
There was a problem hiding this comment.
You are all correct about it. 👍
unkcpz
force-pushed
the
doc/xx/use-sqlite-temp-for-sphinx
branch
2 times, most recently
from
5a4263a to
0b7bf54
Compare
[pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci
unkcpz
force-pushed
the
doc/xx/use-sqlite-temp-for-sphinx
branch
from
0b7bf54 to
a6d3fde
Compare
unkcpz
changed the title
Adding the HyperQueue paper to the README and also to the acknowledgement section of the docs. Moreover, I also added the AiiDA refs to the README. - Finally, I removed the load_documentation_profile function from the conf.py for the docs, as it is deprecated aiidateam/aiida-core#6231.
No description provided.