These errors and warnings are real problems with the docs - they result in badly formatted or missing documentation and also point to errors in the code (like #210).
If we can make sure the docs stay clean via CI, then that is an additional layer of assurance on the project.
WARNING: html_static_path entry '_static' does not exist
WARNING: Failed to import sasdata.quantities.absolute_temperature.
sasdata/data_util/averaging.py:docstring of sasdata.data_util.averaging.CircularAverage:1: ERROR: Undefined substitution referenced: "Q". [docutils]
sasdata/data_util/averaging.py:docstring of sasdata.data_util.averaging.SectorQ:7: ERROR: Undefined substitution referenced: "Q". [docutils]
sasdata/data_util/binning.py:docstring of sasdata.data_util.binning.DirectionalAverage.get_bin_index:7: WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
sasdata/data_util/manipulations.py:docstring of sasdata.data_util.manipulations.SlabX:5: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
sasdata/metadata.py:docstring of sasdata.metadata.meta_tags:23: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
sasdata/model_requirements.py:docstring of sasdata.model_requirements.slit_resolution:62: ERROR: Unknown target name: "q". [docutils]
sasdata/model_requirements.py:docstring of sasdata.model_requirements.slit_resolution:62: ERROR: Unknown target name: "q". [docutils]
sasdata/model_requirements.py:docstring of sasdata.model_requirements.slit_resolution:100: ERROR: Unknown target name: "q". [docutils]
sasdata/model_requirements.py:docstring of sasdata.model_requirements.slit_resolution:100: ERROR: Unknown target name: "q". [docutils]
WARNING: autodoc: failed to import 'absolute_temperature' from module 'sasdata.quantities'; the following exception was raised:
Traceback (most recent call last):
File "/usr/lib/python3/dist-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 131, in _import_from_module_and_path
module = _import_module(module_name, try_reload=True)
File "/usr/lib/python3/dist-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 221, in _import_module
module = importlib.import_module(modname)
File "/usr/lib/python3.14/importlib/__init__.py", line 88, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "<frozen importlib._bootstrap>", line 1406, in _gcd_import
File "<frozen importlib._bootstrap>", line 1371, in _find_and_load
File "<frozen importlib._bootstrap>", line 1342, in _find_and_load_unlocked
File "<frozen importlib._bootstrap>", line 938, in _load_unlocked
File "<frozen importlib._bootstrap_external>", line 759, in exec_module
File "<frozen importlib._bootstrap>", line 491, in _call_with_frames_removed
File "sasdata/quantities/absolute_temperature.py", line 3, in <module>
from sasdata.quantities.accessors import TemperatureAccessor
ModuleNotFoundError: No module named 'sasdata.quantities.accessors'
[autodoc.import_object]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:12: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:20: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:33: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:37: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:45: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:49: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:50: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:51: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:52: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:53: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:58: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:62: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/si.py:docstring of sasdata.quantities.si:70: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:12: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:20: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:33: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:37: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:45: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:49: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:50: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:51: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:52: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:53: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:58: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:62: ERROR: Unexpected indentation. [docutils]
sasdata/quantities/units.py:docstring of sasdata.quantities.units:70: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
checking consistency... docs/source/dev/generated/modules.rst: WARNING: document isn't included in any toctree [toc.not_included]
docs/source/dev/generated/sasdata.rst: document is referenced in multiple toctrees: ['dev/dev', 'dev/generated/modules'], selecting: dev/generated/modules <- dev/generated/sasdata
<unknown>:1: WARNING: more than one target found for cross-reference 'type': sasdata.dataloader.data_info.Aperture.type, sasdata.dataloader.data_info.Source.type, sasdata.dataloader.filereader.FileReader.type, sasdata.dataloader.readers.abs_reader.Reader.type, sasdata.dataloader.readers.anton_paar_saxs_reader.Reader.type, sasdata.dataloader.readers.ascii_reader.Reader.type, sasdata.dataloader.readers.cansas_reader.Reader.type, sasdata.dataloader.readers.cansas_reader_HDF5.Reader.type, sasdata.dataloader.readers.csv_reader.Reader.type, sasdata.dataloader.readers.danse_reader.Reader.type, sasdata.dataloader.readers.red2d_reader.Reader.type, sasdata.dataloader.readers.sesans_reader.Reader.type, sasdata.dataloader.readers.tiff_reader.Reader.type [ref.python]
docs/source/user/data/data_formats_help.rst:20: WARNING: undefined label: 'file_converter_tool' [ref.ref]
docs/source/user/data/data_formats_help.rst:78: WARNING: undefined label: 'file_converter_tool' [ref.ref]
docs/source/user/data/data_formats_help.rst:94: WARNING: undefined label: 'image_viewer_tool' [ref.ref]
docs/source/user/data/data_formats_help.rst:134: WARNING: undefined label: 'sans_calculator_tool' [ref.ref]
These errors and warnings are real problems with the docs - they result in badly formatted or missing documentation and also point to errors in the code (like #210).
The path forward is to:
If we can make sure the docs stay clean via CI, then that is an additional layer of assurance on the project.
q_in the maths; there will be a different way of formatting these equations to fix thatsasdata/example_dataare currently included at all; yes, the entire way of handling example_data still needs fixing