SPy Docs

seeq.spy.docs.copy(folder=None, *, overwrite=False, advanced=True)

Copies the SPy Documentation (Jupyter Notebooks) to a particular folder. This is typically used when the seeq module is installed via PyPI.

This function should be called again with overwrite=True if the seeq module is updated.

Parameters:
  • folder (str) – The folder to receive the documentation. By default it will be copied to a ‘SPy Documentation’ folder in the current working directory.

  • overwrite (bool) – If True, any existing files in the specified folder will be deleted before the documentation is copied in.

  • advanced (bool) – Deprecated.