kikuchipy icon indicating copy to clipboard operation
kikuchipy copied to clipboard

Build documentation on Windows (without PyVista frame buffer)

Open hakonanes opened this issue 1 year ago • 0 comments

For creating the documentation: I tried following the steps in contributing guide, but when I do make html I get the error:

Traceback (most recent call last):
  File "C:\kikuchipy\env\lib\site-packages\sphinx\config.py", line 350, in eval_config_file
    exec(code, namespace)
  File "C:\kikuchipy\doc\conf.py", line 258, in <module>
    pyvista.start_xvfb()
  File "C:\kikuchipy\env\lib\site-packages\pyvista\utilities\xvfb.py", line 44, in start_xvfb
    raise OSError('`start_xvfb` is only supported on Linux')
OSError: `start_xvfb` is only supported on Linux

I am using Windows, does this mean I can only build on Linux? If so, is it sufficient to only create the notebook and you will handle the rest needed?

Originally posted by @Erlendos12 in https://github.com/pyxem/kikuchipy/discussions/630#discussioncomment-5451328


Having start_xvfb() in conf.py hinders Windows/macOS contributors to build the docs on their machines. The frame buffer should still be used on Read The Docs' servers when building the online docs.

We need to find a way for Windows/macOS contributors to still be able to see nice interactive 3D plots in their locally built docs without the framebuffer.

hakonanes avatar Mar 28 '23 09:03 hakonanes