Documentation on system level dependencies and Passing related build failures on Github

nbdev
1

For a project with system level dependencies that are installed with apt-get or brew, some documentation as part of nbdev could be helpful on where should these go. Given I am doing this wrt the nbdev framework, it is currently clear to me.

Some options I am exploring are the following from a what is contained and can I use that to declare the system level dependencies point of view.

  • setup.py
  • settings.ini

Any suggestions or recommendations will be very helpful. Thank you in advance.

2

Im not aware of any way to specify/manage system packages in Python’s packaging framework. I would personally document it in the index.ipynb file which would then also become README.md.