thegraphnetwork / epigraphhub-lib-docs

Documentation for Both R and Python EpigraphHub packages.
https://epigraphhub-libraries.readthedocs.io/en/latest/
BSD 2-Clause "Simplified" License
1 stars 3 forks source link

Review myst_nb operation #7

Open YurelyCamacho opened 1 year ago

YurelyCamacho commented 1 year ago

In the documentation there is an error when executing the notebooks: ModuleNotFoundError: No module named 'epigraphhub'. @Anavelyz and I think it has to do with the myst_nb extension. In addition, the following warning is displayed 'jupyter_execute_notebooks' is deprecated for 'nb_execution_mode' [mystnb.config]

fccoelho commented 1 year ago

In fact, when we compile documentation based on jupyter notebooks, their code is by default executed, and since they depend on importing the epigraphhub library, you have to have the library installed locally in order to properly compile the documentation. If it becomes a problem, I this the execution of code can be turned off in conf.py

Anavelyz commented 1 year ago

@fccoelho We compile the documentation with epigraphhub library in our envs, and we have the same results that currently documentation have. That is, some code line have import errors. You can see it here for example.

fccoelho commented 1 year ago

Dear @Anavelyz the docs build normally on my local computer. I think we need to add the dependencies to the requirements.txt. In particular, epigraphhub is missing, so when Readthedocs builds the docs we get the import errors.