Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Cannot build documentation locally

See original GitHub issue

Describe the bug, what’s wrong, and what you expected.

Trying to build the doc locally following the instructions on the README file with:

make -C doc html

I end up with the following error:

I tried python3.8 and python 3.9 unsucessfully.

It is weird because I can find the charts attribute interactively:

Steps to reproduce the bug.

make -C doc html

System Information

--------------------------------------------------------------------------------
  Date: Wed Nov 30 23:34:10 2022 CET

                OS : Linux
            CPU(s) : 8
           Machine : x86_64
      Architecture : 64bit
               RAM : 15.5 GiB
       Environment : IPython
       File system : ext4
        GPU Vendor : Intel
      GPU Renderer : Mesa Intel(R) HD Graphics 630 (KBL GT2)
       GPU Version : 4.6 (Core Profile) Mesa 21.2.6

  Python 3.9.13 (main, May 23 2022, 22:01:06)  [GCC 9.4.0]

           pyvista : 0.38.dev0
               vtk : 9.2.2
             numpy : 1.23.5
           imageio : 2.22.4
            scooby : 0.7.0
             pooch : v1.6.0
        matplotlib : 3.6.2
           IPython : 8.7.0
          colorcet : 3.0.1
           cmocean : 2.0
        ipyvtklink : 0.2.3
             scipy : 1.9.3
        itkwidgets : 0.32.4
              tqdm : 4.64.1
            meshio : 5.3.4
        jupyterlab : 3.5.0
         pythreejs : Version unknown
--------------------------------------------------------------------------------

Screenshots

No response

Issue Analytics

State:
Created 10 months ago
Comments:8 (8 by maintainers)

Top GitHub Comments

2reactions

banesullivancommented, Dec 2, 2022

I’ve seen a similar issue lately on other projects where import pyvista might be trying to import a directory called pyvista in your path rather than the actual Python package. See if there is a folder called pyvista in your Python Path that isn’t the package directory.

2reactions

MatthewFlammcommented, Dec 1, 2022

I’m wondering if you are importing the local pyvista package when you get a repl, but a different version when making the docs, maybe in the virtual environment or some user or global environment. If you cd, assuming Linux, into the doc folder and then launch the python repl and import pyvista, do you have the same error?

Top Results From Across the Web

Document how to generate docs locally · Issue #1413 - GitHub

Document how to generate docs locally #1413 ... but I could not find, either by reading the Documenter docs, or googling, how to...

Cannot build documentation - Google Groups

I am interesting in the answer on the documentation local build from the git repo too. In the meantime, since AWX forms the...

How do I build the Python documentation locally?

You need to cd Doc/. instead of the top level cpython/ source code directory, then the README file in that directory explains the...

Building documentation

Before building documentation, you must first clone the repository where the files reside. For the instructions on how to clone a repository so...

Frequently Asked Questions - Read the Docs

For libraries that cannot be installed via apt in the builder there is another way to successfully build the documentation despite missing dependencies....