ansys / ansys/pyansys-tools-variableinterop

Cleanup: Fix Sphinx warnings and errors

Open
#100 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Sphinx currently produces a lot of warnings and errors due to various mistakes in the documentation. I have disabled the -W flag in the CI build for now. We should put it back once cleaned up.

```
Running Sphinx v4.5.0
making output directory... done
[autosummary] generating autosummary for: _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.accept.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.clone.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.custom_metadata.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.description.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.equals.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.get_default_value.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.runtime_convert.rst, _autosummary/ansys.common.variableinterop.BooleanArrayMetadata.variable_type.rst, _autosummary/ansys.common.variableinterop.BooleanArrayValue.accept.rst, ..., _autosummary/ansys.common.variableinterop.utils.rst, _autosummary/ansys.common.variableinterop.var_type_array_check.rst, _autosummary/ansys.common.variableinterop.var_type_is_array.rst, _autosummary/ansys.common.variableinterop.variable_state.rst, _autosummary/ansys.common.variableinterop.variable_type.rst, _autosummary/ansys.common.variableinterop.variable_value.rst, _autosummary/ansys.common.variableinterop.vartype_accept.rst, _autosummary/ansys.common.variableinterop.vartype_arrays_and_elements.rst, class_documentation.rst, index.rst
loading intersphinx inventory from https://docs.python.org/dev/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 987 source files that are out of date
updating environment: [new config] 987 added, 0 changed, 0 removed
/home/nsharp/ver/ansys-common-variableinterop/.venv/lib/python3.8/site-packages/numpydoc/docscrape.py:449: UserWarning: Unknown section Throws in the docstring of implicit_coerce_single in /home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/utils/implicit_coercion.py.
warn(msg)
/home/nsharp/ver/ansys-common-variableinterop/.venv/lib/python3.8/site-packages/numpydoc/docscrape.py:449: UserWarning: Unknown section Throws in the docstring of implicit_coerce_single in /home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/utils/implicit_coercion.py.
warn(msg)
reading sources... [100%] index
WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.BooleanArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/scalar_values.py:docstring of ansys.common.variableinterop.scalar_values.BooleanValue:4: ERROR: Unknown target name: "numpy.bool".
WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.CommonArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.tobytes':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.denominator':
SS02: Summary does not start with a capital letter

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.numerator':
SS02: Summary does not start with a capital letter

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.denominator':
SS02: Summary does not start with a capital letter

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.numerator':
SS02: Summary does not start with a capital letter

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.IntegerValue.tobytes':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealValue.tobytes':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.RealValue.tobytes':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.astype':
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, Raises, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.copy':
GL06: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.dot':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.real':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.shape':
GL07: Sections are in the wrong order. Correct order is: See Also, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.strides':
GL07: Sections are in the wrong order. Correct order is: See Also, Notes, Examples

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringArrayValue.tostring':
GL09: Deprecation warning should precede extended summary

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringValue.tobytes':
GL08: The object does not have a docstring

/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/scalar_values.py:docstring of ansys.common.variableinterop.scalar_values.StringValue:4: ERROR: Unknown target name: "str".
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/scalar_values.py:docstring of ansys.common.variableinterop.scalar_values.StringValue:4: ERROR: Unknown target name: "numpy.str".
WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringValue.conj':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.StringValue.tobytes':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.implicit_coerce_single':
GL06: Found unknown section "Throws". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.importlib_metadata.FileHash':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.importlib_metadata.MetadataPathFinder':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.importlib_metadata.PathDistribution':
GL08: The object does not have a docstring

WARNING: [numpydoc] Validation warnings while processing docstring for 'ansys.common.variableinterop.implicit_coerce_single':
GL06: Found unknown section "Throws". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, Warnings, See Also, Notes, References, Examples
GL07: Sections are in the wrong order. Correct order is: Parameters, Returns

looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/nsharp/ver/ansys-common-variableinterop/doc/source/_autosummary/ansys.common.variableinterop.GetModelCenterTypeForValue.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.BooleanArrayValue.fill:18: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.BooleanArrayValue.item:30: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.CommonArrayValue.fill:18: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.CommonArrayValue.item:30: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.IntegerArrayValue.fill:18: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.IntegerArrayValue.item:30: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.RealArrayValue.fill:18: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.RealArrayValue.item:30: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.StringArrayValue.fill:18: WARNING: undefined label: numpy:arrays.scalars
/home/nsharp/ver/ansys-common-variableinterop/src/ansys/common/variableinterop/__init__.py:docstring of ansys.common.variableinterop.StringArrayValue.item:30: WARNING: undefined label: numpy:arrays.scalars
generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 105 warnings.

The HTML pages are in build/html.
```

Contributor guide

Open the contributing guide

Research direction

Start by running the Sphinx documentation build with -W enabled and review the warnings listed in the issue. Inspect docstrings in src/ansys/common/variableinterop/utils/implicit_coercion.py and scalar_values.py, along with the reported numpydoc section-order and cross-reference issues. Done means the documented warnings and errors are resolved and CI can restore -W.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.