[jira] [Resolved] (CLIMATE-760) Address documentation warnings

["Lewis John McGibbney (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CLIMATE-760?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lewis John McGibbney resolved CLIMATE-760.
------------------------------------------
    Resolution: Fixed

Thank you [~jarifibrahim]

> Address documentation warnings
> ------------------------------
>
>                 Key: CLIMATE-760
>                 URL: https://issues.apache.org/jira/browse/CLIMATE-760
>             Project: Apache Open Climate Workbench
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Lewis John McGibbney
>            Assignee: Lewis John McGibbney
>            Priority: Trivial
>             Fix For: 1.2
>
>
> When building the documentation we get the following
> {code}
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_GPM_IMERG_files:13: ERROR: Unexpected indentation.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_GPM_IMERG_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_GPM_IMERG_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_GPM_IMERG_files:14: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_NLDAS_forcingA_files:14: ERROR: Unexpected indentation.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_NLDAS_forcingA_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_NLDAS_forcingA_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_NLDAS_forcingA_files:15: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files:14: ERROR: Unexpected indentation.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files:15: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files_RAIN:10: ERROR: Unexpected indentation.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files_RAIN:1: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_WRF_2d_files_RAIN:11: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_dataset_from_multiple_netcdf_files:8: ERROR: Unexpected indentation.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_dataset_from_multiple_netcdf_files:9: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/data_source/local.py:docstring of local.load_dataset_from_multiple_netcdf_files:21: ERROR: Unknown interpreted text role "list".
> /usr/local/climate/ocw/dataset.py:docstring of dataset.Dataset.spatial_resolution:5: WARNING: Block quote ends without a blank line; unexpected unindent.
> /usr/local/climate/ocw/dataset_processor.py:docstring of dataset_processor.temperature_unit_conversion:6: WARNING: Field list ends without a blank line; unexpected unindent.
> looking for now-outdated files... none found
> pickling environment... done
> checking consistency... /usr/local/climate/docs/source/config/config_writer.rst:: WARNING: document isn't included in any toctree
> /usr/local/climate/docs/source/config/dataset_information.rst:: WARNING: document isn't included in any toctree
> /usr/local/climate/docs/source/config/evaluation_settings.rst:: WARNING: document isn't included in any toctree
> /usr/local/climate/docs/source/config/metrics_information.rst:: WARNING: document isn't included in any toctree
> /usr/local/climate/docs/source/config/plots_settings.rst:: WARNING: document isn't included in any toctree
> done
> preparing documents... done
> writing output... [100%] ui-backend/backend
> writing additional files... genindex http-routingtable py-modindex search
> copying static files... WARNING: html_static_path entry u'/usr/local/climate/docs/source/_static' does not exist
> done
> copying extra files... done
> dumping search index... done
> dumping object inventory... done
> build succeeded, 27 warnings.
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)