Skip to content

Commit 9abe91c

Browse files
VaghinakDevVaghinakDev
authored
Merge pull request #563 from superannotateai/docs_update
docs warnings fix and html content changes
2 parents 6743eb2 + 2a31579 commit 9abe91c

File tree

21 files changed

+132
-456
lines changed

21 files changed

+132
-456
lines changed

‎docs/source/api_reference/api_annotation_class.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
==================
22
Annotation Classes
3-
==========
3+
==================
44

55
.. automethod:: superannotate.SAClient.create_annotation_class
66
.. _ref_create_annotation_classes_from_classes_json:

‎docs/source/api_reference/api_client.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
==================
22
SAClient interface
3-
==========
3+
==================
44

55
Contents
66
========
@@ -18,4 +18,3 @@ Contents
1818
api_team
1919
api_neural_network
2020

21-
---

‎docs/source/api_reference/api_custom_metadata.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
===============
22
Custom Metadata
3-
==========
3+
===============
44

55
.. automethod:: superannotate.SAClient.create_custom_fields
66
.. automethod:: superannotate.SAClient.get_custom_fields

‎docs/source/api_reference/api_item.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
=====
22
Items
3-
==========
3+
=====
44

55

66
.. automethod:: superannotate.SAClient.query

‎docs/source/api_reference/api_metadata.rst‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
==========
1+
=========================
22
Remote metadata reference
3-
==========
3+
=========================
4+
45

56
Projects metadata
67
_________________
8+
79
.. _ref_metadata:
10+
811
Project metadata example:
912

1013
.. code-block:: python

‎docs/source/api_reference/api_neural_network.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
==============
22
Neural Network
3-
==========
3+
==============
44

55

66
.. automethod:: superannotate.SAClient.download_model

‎docs/source/api_reference/cli_client.rst‎

Lines changed: 0 additions & 222 deletions
This file was deleted.

‎docs/source/api_reference/helpers.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
1+
================================
22
Annotation JSON helper functions
3-
==========
3+
================================
44

55

66
.. _ref_converter:

‎docs/source/api_reference/index.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,4 @@ Contents
1111

1212
api_client
1313
api_metadata
14-
helpers
15-
---
14+
helpers

‎docs/source/cli_client.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _ref_cli:
22

3-
==========
3+
=============
44
CLI Reference
5-
==========
5+
=============
66

77
With SuperAnnotate CLI, basic tasks can be accomplished using shell commands:
88

@@ -12,7 +12,7 @@ With SuperAnnotate CLI, basic tasks can be accomplished using shell commands:
1212
1313
To use the CLI a command line initialization step should be performed after the
1414

15-
:ref:`installation <_ref_quickstart>`:
15+
:ref:`installation <ref_quickstart>`:
1616

1717
.. code-block:: bash
1818

0 commit comments

Comments
 (0)