equinor/fmu-dataio

Resolve warnings and errors when docs are built

Closed this issue · 0 comments

When building the docs several thousand warnings and errors are issued.

The warnings may be difficult to suppress; they originate from here which is a very generic warning issued from within Sphinx. Maybe there is something we can do.

The errors should be possible to be resolve. They seem to come specifically from Pydantic classes that do not inherit the docstrings from the base class. Something is interpreting some aspect of them as raw directives. More investigation is needed.

fmu-dataio/docs/src/datamodel/model/FMUDataClassMeta/Masterdata/fmu.dataio.datastructure.meta.meta.Smda.rst:26:<autosummary>:1: ERROR: Content block expected for the "raw" directive; none found.
fmu-dataio/docs/src/datamodel/model/FMUDataClassMeta/Masterdata/fmu.dataio.datastructure.meta.meta.Smda.rst:26:<autosummary>:1: ERROR: Content block expected for the "raw" directive; none found.
fmu-dataio/docs/src/datamodel/model/FMUDataClassMeta/Masterdata/fmu.dataio.datastructure.meta.meta.Smda.rst:26:<autosummary>:1: ERROR: Content block expected for the "raw" directive; none found.
fmu-dataio/docs/src/datamodel/model/FMUDataClassMeta/Masterdata/fmu.dataio.datastructure.meta.meta.Smda.rst:26:<autosummary>:1: ERROR: Content block expected for the "raw" directive; none found.
fmu-dataio/docs/src/datamodel/model/FMUDataClassMeta/Masterdata/fmu.dataio.datastructure.meta.meta.Smda.rst:26:<autosummary>:1: ERROR: Content block expected for the "raw" directive; none found.

(A random error example)

In RST, raw directive is of the form

.. raw:: <...>
   <...>

This error may be originating with within autopydantic_model itself as no raw directive exists in the generated document.

Smda.rst:

Smda
====

.. currentmodule:: fmu.dataio.datastructure.meta.meta

.. autosummary::
   :toctree: Smda
   :recursive:

   .. toctree::
      :maxdepth: -1

   
   
      ~fmu.dataio.datastructure.meta.meta.DiscoveryItem
   
      ~fmu.dataio.datastructure.meta.meta.CountryItem
   
      ~fmu.dataio.datastructure.meta.meta.StratigraphicColumn
   
      ~fmu.dataio.datastructure.meta.meta.FieldItem
   
      ~fmu.dataio.datastructure.meta.meta.CoordinateSystem
   
   

.. autopydantic_model:: Smda
   :members:
   :inherited-members: BaseModel
   :model-show-config-summary: False
   :model-show-json: False
   :model-show-validator-members: False
   :model-show-validator-summary: False
   :field-list-validators: False

   
   
   

   
   
   

(white space included)