autodoc failures

[donald-e-boyce]

I get a number of failures when I build the docs. There are a number of indentation errors, missing files and incorrect imports that ought to be fixed.

• It seems to expect a copyright file named COPYING
• Unexpected indentation in wppf/RietveldHEDM.py line 114
• Bad Import:
  • No module named 'hexrd.nf_config.tomography'
  • No module named 'hexrrd'

These should be easy to fix.

Here are the error messages:

reading sources... [100%] hexrd.wppf.derivatives
WARNING: autodoc: failed to import module 'copyright' from module 'hexrd'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/deboyce/miniconda3/envs/hexrd-dev/lib/python3.11/site-packages/sphinx/ext/autodoc/importer.py", line 69, in import_module
    return importlib.import_module(modname)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/deboyce/miniconda3/envs/hexrd-dev/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 940, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/Users/deboyce/Source/hexrd/branches/hexrd-dev/hexrd/copyright.py", line 38, in <module>
    with open(os.path.join(os.path.dirname(__file__), COPYRIGHT_FILE), 'r') as f:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/Users/deboyce/Source/hexrd/branches/hexrd-dev/hexrd/COPYING'

WARNING: autodoc: failed to import module 'nf_config' from module 'hexrd'; the following exception was raised:
No module named 'hexrd.nf_config.tomography'
WARNING: autodoc: failed to import module 'nf_config.nf_root' from module 'hexrd'; the following exception was raised:
No module named 'hexrd.nf_config.tomography'
WARNING: autodoc: failed to import module 'RietveldHEDM' from module 'hexrd.wppf'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/deboyce/miniconda3/envs/hexrd-dev/lib/python3.11/site-packages/sphinx/ext/autodoc/importer.py", line 69, in import_module
    return importlib.import_module(modname)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/deboyce/miniconda3/envs/hexrd-dev/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 936, in exec_module
  File "<frozen importlib._bootstrap_external>", line 1074, in get_code
  File "<frozen importlib._bootstrap_external>", line 1004, in source_to_code
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/Users/deboyce/Source/hexrd/branches/hexrd-dev/hexrd/wppf/RietveldHEDM.py", line 114
    """
    ^^^
IndentationError: expected an indented block after function definition on line 108

WARNING: autodoc: failed to import module 'derivatives' from module 'hexrd.wppf'; the following exception was raised:
No module named 'hexrrd'