From 93e1f6de0ebcef55b565cd38bd534fe0d990ad17 Mon Sep 17 00:00:00 2001 From: Rafal Skolasinski Date: Fri, 17 Jan 2020 15:39:26 +0000 Subject: [PATCH] fix links do images descriptions, closes #1249 --- doc/README.md | 15 ++++++++++- doc/source/reference/images.md | 27 +++++++++---------- .../reference/integration_nvidia_link.rst | 1 + .../reference/integration_sagemaker_link.rst | 1 + .../reference/integration_tfserving_link.rst | 1 + 5 files changed, 30 insertions(+), 15 deletions(-) create mode 100644 doc/source/reference/integration_nvidia_link.rst create mode 100644 doc/source/reference/integration_sagemaker_link.rst create mode 100644 doc/source/reference/integration_tfserving_link.rst diff --git a/doc/README.md b/doc/README.md index 34e11bf6a5..c0182461b7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -31,4 +31,17 @@ We use various Sphinx extensions and plugins to build the documentation: * [nbsphinx](https://nbsphinx.readthedocs.io) - parsing Jupyter notebooks to generate static documentation * [nbsphinx_link](https://nbsphinx-link.readthedocs.io) - support linking to notebooks outside of Sphinx source directory via `.nblink` files -The full list of plugins and their options can be found in `source/conf.py`. \ No newline at end of file +The full list of plugins and their options can be found in `source/conf.py`. + +## Tips & Tricks + +### Linking to markdown outside of `doc/source` + +Referencing documents outside of `doc/source` tree does not work out of the box but there +is an easy workaround: + +1. Create a simple `rst` file including `include` or `mdinclude` directive, e.g. see [this](source/reference/integration_nvidia_link.rst) link referenced [here](source/reference/images.md) + + .. mdinclude:: ../../../integrations/nvidia-inference-server/README.md + +2. Reference this file instead of included one diff --git a/doc/source/reference/images.md b/doc/source/reference/images.md index b77390a5e7..23e49307af 100644 --- a/doc/source/reference/images.md +++ b/doc/source/reference/images.md @@ -5,18 +5,18 @@ |-------------|-----------|----------------|-------------| | Seldon Operator | [seldonio/seldon-core-operator](https://hub.docker.com/r/seldonio/seldon-core-operator/tags/) | 1.0.1 | 1.0.2-SNAPSHOT | | Seldon Service Orchestrator | [seldonio/engine](https://hub.docker.com/r/seldonio/engine/tags/) | 1.0.1 | 1.0.2-SNAPSHOT | -| [Seldon Python 3 (3.6) Wrapper for S2I](docs/wrappers/python.md) | [seldonio/seldon-core-s2i-python3](https://hub.docker.com/r/seldonio/seldon-core-s2i-python3/tags/) | 0.16 | 0.17-SNAPSHOT | -| [Seldon Python 3.6 Wrapper for S2I](docs/wrappers/python.md) | [seldonio/seldon-core-s2i-python36](https://hub.docker.com/r/seldonio/seldon-core-s2i-python36/tags/) | 0.16 | 0.17-SNAPSHOT | -| [Seldon Python 3.7 Wrapper for S2I](docs/wrappers/python.md) | [seldonio/seldon-core-s2i-python37](https://hub.docker.com/r/seldonio/seldon-core-s2i-python37/tags/) | 0.16 | 0.17-SNAPSHOT | -| [Seldon Python 2 Wrapper for S2I](docs/wrappers/python.md) | [seldonio/seldon-core-s2i-python2](https://hub.docker.com/r/seldonio/seldon-core-s2i-python2/tags/) | 0.5.1 | deprecated | -| [Seldon Python ONNX Wrapper for S2I](docs/wrappers/python.md) | [seldonio/seldon-core-s2i-python3-ngraph-onnx](https://hub.docker.com/r/seldonio/seldon-core-s2i-python3-ngraph-onnx/tags/) | 0.3 | | -| [Seldon Java Build Wrapper for S2I](docs/wrappers/java.md) | [seldonio/seldon-core-s2i-java-build](https://hub.docker.com/r/seldonio/seldon-core-s2i-java-build/tags/) | 0.1 | | -| [Seldon Java Runtime Wrapper for S2I](docs/wrappers/java.md) | [seldonio/seldon-core-s2i-java-runtime](https://hub.docker.com/r/seldonio/seldon-core-s2i-java-runtime/tags/) | 0.1 | | -| [Seldon R Wrapper for S2I](docs/wrappers/r.md) | [seldonio/seldon-core-s2i-r](https://hub.docker.com/r/seldonio/seldon-core-s2i-r/tags/) | 0.2 | | -| [Seldon NodeJS Wrapper for S2I](docs/wrappers/nodejs.md) | [seldonio/seldon-core-s2i-nodejs](https://hub.docker.com/r/seldonio/seldon-core-s2i-nodejs/tags/) | 0.1 | 0.2-SNAPSHOT | -| [Seldon Tensorflow Serving proxy](integrations/tfserving/README.md) | [seldonio/tfserving-proxy](https://hub.docker.com/r/seldonio/tfserving-proxy/tags/) | 0.1 | | -| [Seldon NVIDIA inference server proxy](integrations/nvidia-inference-server/README.md) | [seldonio/nvidia-inference-server-proxy](https://hub.docker.com/r/seldonio/nvidia-inference-server-proxy/tags/) | 0.1 | | -| [Seldon AWS SageMaker proxy](integrations/sagemaker/README.md) | [seldonio/sagemaker-proxy](https://hub.docker.com/r/seldonio/sagemaker-proxy/tags/) | 0.1 | || +| [Seldon Python 3 (3.6) Wrapper for S2I](../python/python_wrapping_s2i.md) | [seldonio/seldon-core-s2i-python3](https://hub.docker.com/r/seldonio/seldon-core-s2i-python3/tags/) | 0.16 | 0.17-SNAPSHOT | +| [Seldon Python 3.6 Wrapper for S2I](../python/python_wrapping_s2i.md) | [seldonio/seldon-core-s2i-python36](https://hub.docker.com/r/seldonio/seldon-core-s2i-python36/tags/) | 0.16 | 0.17-SNAPSHOT | +| [Seldon Python 3.7 Wrapper for S2I](../python/python_wrapping_s2i.md) | [seldonio/seldon-core-s2i-python37](https://hub.docker.com/r/seldonio/seldon-core-s2i-python37/tags/) | 0.16 | 0.17-SNAPSHOT | +| [Seldon Python 2 Wrapper for S2I](../python/python_wrapping_s2i.md) | [seldonio/seldon-core-s2i-python2](https://hub.docker.com/r/seldonio/seldon-core-s2i-python2/tags/) | 0.5.1 | deprecated | +| [Seldon Python ONNX Wrapper for S2I](../python/python_wrapping_s2i.md) | [seldonio/seldon-core-s2i-python3-ngraph-onnx](https://hub.docker.com/r/seldonio/seldon-core-s2i-python3-ngraph-onnx/tags/) | 0.3 | | +| [Seldon Java Build Wrapper for S2I](../java/README.md) | [seldonio/seldon-core-s2i-java-build](https://hub.docker.com/r/seldonio/seldon-core-s2i-java-build/tags/) | 0.1 | | +| [Seldon Java Runtime Wrapper for S2I](../java/README.md) | [seldonio/seldon-core-s2i-java-runtime](https://hub.docker.com/r/seldonio/seldon-core-s2i-java-runtime/tags/) | 0.1 | | +| [Seldon R Wrapper for S2I](../R/README.md) | [seldonio/seldon-core-s2i-r](https://hub.docker.com/r/seldonio/seldon-core-s2i-r/tags/) | 0.2 | | +| [Seldon NodeJS Wrapper for S2I](../nodejs/README.md) | [seldonio/seldon-core-s2i-nodejs](https://hub.docker.com/r/seldonio/seldon-core-s2i-nodejs/tags/) | 0.1 | 0.2-SNAPSHOT | +| [Seldon Tensorflow Serving proxy](integration_tfserving_link.rst) | [seldonio/tfserving-proxy](https://hub.docker.com/r/seldonio/tfserving-proxy/tags/) | 0.1 | | +| [Seldon NVIDIA inference server proxy](integration_nvidia_link.rst) | [seldonio/nvidia-inference-server-proxy](https://hub.docker.com/r/seldonio/nvidia-inference-server-proxy/tags/) | 0.1 | | +| [Seldon AWS SageMaker proxy](integration_sagemaker_link.rst) | [seldonio/sagemaker-proxy](https://hub.docker.com/r/seldonio/sagemaker-proxy/tags/) | 0.1 | || ## Java Packages @@ -30,5 +30,4 @@ | Description | Python Version | Version | |-------------|----------------|---------| | [seldon-core](https://pypi.org/project/seldon-core/) | >3.4,<3.7 | 1.0.1 | -| [seldon-core](https://pypi.org/project/seldon-core/) | 2,>=3,<3.7 | 0.2.6 (deprecated) | - +| [seldon-core](https://pypi.org/project/seldon-core/) | 2,>=3,<3.7 | 0.2.6 (deprecated) | diff --git a/doc/source/reference/integration_nvidia_link.rst b/doc/source/reference/integration_nvidia_link.rst new file mode 100644 index 0000000000..95a08b59c1 --- /dev/null +++ b/doc/source/reference/integration_nvidia_link.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../../integrations/nvidia-inference-server/README.md diff --git a/doc/source/reference/integration_sagemaker_link.rst b/doc/source/reference/integration_sagemaker_link.rst new file mode 100644 index 0000000000..7be68a0e2f --- /dev/null +++ b/doc/source/reference/integration_sagemaker_link.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../../integrations/sagemaker/README.md diff --git a/doc/source/reference/integration_tfserving_link.rst b/doc/source/reference/integration_tfserving_link.rst new file mode 100644 index 0000000000..4f5cec849d --- /dev/null +++ b/doc/source/reference/integration_tfserving_link.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../../integrations/tfserving/README.md