Skip to content

Commit 231f6d9

Browse files
author
Jihyeon Yi
authored
hotfix indent of installation document (#1207)
<!-- Contributing guide: https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md --> ### Summary The installation document was incorrect due to the indentation like below: ![image](https://github.com/openvinotoolkit/datumaro/assets/75776702/cb8f0ee9-f81b-4a78-9948-36c55d972d22) So, I corrected the indentation of the document. <!-- Resolves #111 and #222. Depends on #1000 (for series of dependent commits). This PR introduces this capability to make the project better in this and that. - Added this feature - Removed that feature - Fixed the problem #1234 --> ### How to test <!-- Describe the testing procedure for reviewers, if changes are not fully covered by unit tests or manual testing can be complicated. --> ### Checklist <!-- Put an 'x' in all the boxes that apply --> - [ ] I have added unit tests to cover my changes.​ - [ ] I have added integration tests to cover my changes.​ - [x] I have added the description of my changes into [CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​ - [x] I have updated the [documentation](https://github.com/openvinotoolkit/datumaro/tree/develop/docs) accordingly ### License - [ ] I submit _my code changes_ under the same [MIT License](https://github.com/openvinotoolkit/datumaro/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. - [ ] I have updated the license header for each file (see an example below). ```python # Copyright (C) 2023 Intel Corporation # # SPDX-License-Identifier: MIT ```
1 parent 44c1391 commit 231f6d9

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- Fix wrong example of Datumaro dataset creation in document
1717
(<https://github.com/openvinotoolkit/datumaro/pull/1195>)
1818
- Fix wrong command to install datumaro from github
19-
(<https://github.com/openvinotoolkit/datumaro/pull/1202>)
19+
(<https://github.com/openvinotoolkit/datumaro/pull/1202>, <https://github.com/openvinotoolkit/datumaro/pull/1207>)
2020

2121
## 16/11/2023 - Release 1.5.1
2222
### Enhancements

docs/source/docs/get-started/quick-start-guide/installation.rst

+16-15
Original file line numberDiff line numberDiff line change
@@ -22,33 +22,34 @@ Install:
2222

2323
1. From PyPI (**recommended**)
2424

25-
.. code-block::
25+
.. code-block::
26+
27+
pip install datumaro[default]
2628
27-
pip install datumaro[default]
2829
2930
Alternatively, for zsh users:
3031

31-
.. code-block::
32+
.. code-block::
3233
33-
pip install 'datumaro[default]'
34+
pip install 'datumaro[default]'
3435
3536
3637
2. From the GitHub repository (**not recommended, for advanced users**)
3738

38-
Installation from the repository source is not recommended.
39-
This is because it requires that C++ and Rust build systems are prepared in your local environment before installation.
40-
Datumaro includes C++ and Rust implementations to accelerate some workloads to overcome Python's innate slowness.
39+
Installation from the repository source is not recommended.
40+
This is because it requires that C++ and Rust build systems are prepared in your local environment before installation.
41+
Datumaro includes C++ and Rust implementations to accelerate some workloads to overcome Python's innate slowness.
4142

42-
.. code-block::
43+
.. code-block::
4344
44-
# Prerequisite (For Unix-like systems)
45-
# Install C++ build system
46-
sudo apt-get install build-essential
47-
# Install Rust build system
48-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
45+
# Prerequisite (For Unix-like systems)
46+
# Install C++ build system
47+
sudo apt-get install build-essential
48+
# Install Rust build system
49+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
4950
50-
# Install from the GitHub repository
51-
pip install 'datumaro[default] @ git+https://github.com/openvinotoolkit/datumaro'
51+
# Install from the GitHub repository
52+
pip install 'datumaro[default] @ git+https://github.com/openvinotoolkit/datumaro'
5253
5354
5455
Plugins

0 commit comments

Comments
 (0)