From 1f3d2f8ce30adaf9b7bceb0e9856c3856866203a Mon Sep 17 00:00:00 2001 From: "valentin.kozlov" Date: Tue, 26 Sep 2023 19:15:54 +0200 Subject: [PATCH] [docs] Resolve some warnings in the docs --- CONTRIBUTING.md | 2 +- doc/source/cli/deepaas-predict.rst | 4 ++-- doc/source/cli/index.rst | 4 +++- doc/source/conf.py | 1 + 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8dfe0a5..9699a8ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,7 +136,7 @@ Before you submit a pull request, check that it meets these guidelines: Tox uses `py.test` under the hood, hence it supports the same syntax for selecting tests. -For further information please consult the `pytest usage docs`_. +For further information please consult the [pytest usage docs](https://docs.pytest.org/en/latest/usage.html#specifying-tests-selecting-tests). To run a particular test class with tox:: diff --git a/doc/source/cli/deepaas-predict.rst b/doc/source/cli/deepaas-predict.rst index ed7f0e14..53dee532 100644 --- a/doc/source/cli/deepaas-predict.rst +++ b/doc/source/cli/deepaas-predict.rst @@ -1,6 +1,6 @@ -=========== +================ deepaas-predict -=========== +================ Synopsis ======== diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 58ca69e2..772d3c29 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -5,4 +5,6 @@ Available commands .. toctree:: :maxdepth: 1 - * + deepaas-cli + deepaas-predict + deepaas-run diff --git a/doc/source/conf.py b/doc/source/conf.py index 54fe2abc..597e63ad 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -37,6 +37,7 @@ 'oslo_config.sphinxconfiggen', 'oslo_config.sphinxext', "reno.sphinxext", + "recommonmark", ] # Add any paths that contain templates here, relative to this directory.