Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build documentation on Windows (without PyVista frame buffer) #631

Open
hakonanes opened this issue Mar 28, 2023 · 0 comments
Open

Build documentation on Windows (without PyVista frame buffer) #631

hakonanes opened this issue Mar 28, 2023 · 0 comments
Labels
documentation This relates to the documentation help wanted Would be nice if someone could help

Comments

@hakonanes
Copy link
Member

hakonanes commented Mar 28, 2023

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 #630 (reply in thread)


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 hakonanes added the documentation This relates to the documentation label Mar 28, 2023
@hakonanes hakonanes added the help wanted Would be nice if someone could help label Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation help wanted Would be nice if someone could help
Projects
None yet
Development

No branches or pull requests

1 participant