Many warnings are shown when build the docs

[fepegar]

cp ../CHANGELOG.md source/
Running Sphinx v4.1.2
loading pickled environment... done
myst v0.15.2: MdParserConfig(renderer='sphinx', commonmark_only=False, enable_extensions=['dollarmath'], dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', disable_syntax=[], url_schemes=['http', 'https', 'mailto', 'ftp'], heading_anchors=None, heading_slug_func=None, html_meta=[], footnote_transition=True, substitutions=[], sub_delimiters=['{', '}'], words_per_minute=200)
[autosummary] generating autosummary for: CHANGELOG.md, api/api.rst, api/health_azure.AzureRunInfo.rst, api/health_azure.DatasetConfig.rst, api/health_azure.aggregate_hyperdrive_metrics.rst, api/health_azure.create_aml_run_object.rst, api/health_azure.create_crossval_hyperdrive_config.rst, api/health_azure.create_run_configuration.rst, api/health_azure.create_script_run.rst, api/health_azure.download_checkpoints_from_run_id.rst, ..., first_steps.md, histopathology.md, hyperdrive.md, index.rst, loading_images.md, logging.md, lowpriority.md, runner.md, self_supervised_models.md, whole_slide_images.md
[automodsumm] api/api.rst: found 23 automodsumm entries to generate
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 15 changed, 0 removed
reading sources... [100%] index
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:7: WARNING: Line block ends without a blank line.
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:19: WARNING: Line block ends without a blank line.
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:19: WARNING: Inline substitution_reference start-string without end-string.
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:27: WARNING: Line block ends without a blank line.
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:7: WARNING: Undefined substitution referenced: "--------------".
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:7: WARNING: Undefined substitution referenced: "--------------------".
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:19: WARNING: Undefined substitution referenced: "----------------".
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:19: WARNING: Undefined substitution referenced: "-------------------------------------------".
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:27: WARNING: Undefined substitution referenced: "----------------".
/home/fernando/git/hi-ml/hi-ml-azure/src/health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics:27: WARNING: Undefined substitution referenced: "---------------------------------------".
/home/fernando/git/hi-ml/docs/source/index.rst:50: WARNING: toctree contains reference to nonexisting document 'CONTRIBUTING'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/fernando/git/hi-ml/docs/source/examples/1/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/10/inputs.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/10/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/2/environment.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/2/results.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/2/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/3/results.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/3/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/4/results.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/4/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/5/inputs.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/5/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/6/inputs.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/6/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/7/inputs.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/7/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/8/inputs.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/8/sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/9/aml_sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/9/pytorch_sample.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/9/tensorboard_env.rst: WARNING: document isn't included in any toctree
/home/fernando/git/hi-ml/docs/source/examples/modify_checkpoint/modify_checkpoint.rst: WARNING: document isn't included in any toctree

Issues:

1. Wrong docstring formatting in health_azure/utils.py:docstring of health_azure.utils.aggregate_hyperdrive_metrics. I'll submit a PR in a minute
2. Examples not included in any toctree. Is that expected?
3. CONTRIBUTING.md not found. I'll submit a PR in a minute

@ant0nsc @mebristo shall we move CONTRIBUTING.md to the root?

[mebristo]

This is great, thanks! Re the samples files not being in any toctree, yes this is expected. These files are linked to in other areas of the docs (mostly in the examples.md file)

[fepegar]

Do you think it's a good idea to include them within examples.md so this doesn't happen?