Skip to content

Commit c3ba16d

Browse files
committed
Improve docs
1 parent 13197e9 commit c3ba16d

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ for COCO annotation format converters support also need to install:
5454
pip install "git+https://github.com/cocodataset/panopticapi.git"
5555
pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"
5656
57-
The package officially supports Python 3.6+ and was tested under Linux platform.
57+
The package officially supports Python 3.6+ and was tested under Linux and
58+
Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`_) platforms.
5859

5960
For more detailed installation steps and package usage please have a look at
6061
the :ref:`tutorial <ref_tutorial>`.

docs/source/tutorial.sdk.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,17 @@ for COCO annotation format converters support also need to install:
2424
pip install "git+https://github.com/cocodataset/panopticapi.git"
2525
pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"
2626
27-
The package officially supports Python 3.6+ and was tested under Linux platform.
27+
The package officially supports Python 3.6+ and was tested under Linux and
28+
Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`_) platforms.
2829

2930
For Windows based Anaconda distribution
30-
you might also need to install :py:obj:`shapely` package separately:
31+
you might also need to install beforehand :py:obj:`shapely` package:
3132

3233
.. code-block:: bash
3334
3435
conda install shapely
3536
36-
and also need to install C++ build tools from `Microsoft Visual Studio Tools
37+
and C++ build tools from `Microsoft Visual Studio Tools
3738
<https://visualstudio.microsoft.com/visual-cpp-build-tools/>`_.
3839

3940
----------

superannotate/input_converters/conversion.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def _passes_converter_sanity(args, direction):
143143
if not test_passed:
144144
raise SABaseException(
145145
0,
146-
"Please enter valid converter values. You can check available candidates in the documentation(https://superannotate.readthedocs.io/en/latest/index.html)."
146+
"Please enter valid converter values. You can check available candidates in the documentation (https://superannotate.readthedocs.io/en/stable/index.html)."
147147
)
148148

149149

0 commit comments

Comments
 (0)