MathEXLab / PySPOD

A Python package for spectral proper orthogonal decomposition (SPOD).
https://mathexlab.github.io/PySPOD/
MIT License
97 stars 29 forks source link

Error building documentation. "AttributeError: module 'pyspod' has no attribute '__copyright__'" #4

Closed jdmoorman closed 3 years ago

jdmoorman commented 3 years ago

Running the following as explained in README.md results in an error.

$ git clone https://github.com/mengaldo/PySPOD
$ cd PySPOD
$ python setup.py install
$ cd docs
$ make html

The resulting error message output by make html follows.

Running Sphinx v2.4.2

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/Users/jdmoorman/opt/miniconda3/lib/python3.7/site-packages/sphinx/config.py", line 348, in eval_config_file
    execfile_(filename, namespace)
  File "/Users/jdmoorman/opt/miniconda3/lib/python3.7/site-packages/sphinx/util/pycompat.py", line 81, in execfile_
    exec(code, _globals)
  File "/Users/jdmoorman/Git/PySPOD/docs/source/conf.py", line 74, in <module>
    copyright = pyspod.__copyright__
AttributeError: module 'pyspod' has no attribute '__copyright__'

make: *** [html] Error 2

Looks like the issue is related to the variables (e.g. copyright) defined on lines 22-29 of docs/conf.py being overwritten on lines 72-75 and 85-87 by undefined metadata from the pyspod package (e.g. pyspod.__copyright__).

jdmoorman commented 3 years ago

openjournals/joss-reviews#2862

mengaldo commented 3 years ago

@jdmoorman This should be now fixed, thank you.