Skip to content

Commit 819bc44

Browse files
committed
update overview doc
1 parent 233d6cf commit 819bc44

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
'sphinx.ext.todo',
4545
'sphinx.ext.napoleon',
4646
'sphinx.ext.coverage',
47+
'sphinx_copybutton',
4748
]
4849

4950
# Add any paths that contain templates here, relative to this directory.

docs/overview.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,25 @@ Prerequisites
1414
-------------
1515

1616
* Python 3.8 or higher;
17-
* `pip` version 9.0.1 or higher;
17+
* ``pip`` version 9.0.1 or higher;
1818

19-
If necessary, upgrade your version of `pip`::
19+
If necessary, upgrade your version of ``pip``::
2020

21-
$ python -m pip install --upgrade pip
21+
python -m pip install --upgrade pip
2222

2323
If you cannot upgrade `pip` due to a system-owned installation, you can run the example in a virtualenv::
2424

25-
$ python -m pip install virtualenv
26-
$ virtualenv venv
27-
$ source venv/bin/activate
28-
$ python -m pip install --upgrade pip
25+
python -m pip install virtualenv
26+
virtualenv venv
27+
source venv/bin/activate
28+
python -m pip install --upgrade pip
2929

3030
Installation via Pypi
3131
---------------------
3232

3333
To install YDB Python SDK through Pypi execute the following command::
34-
35-
$ pip install ydb
34+
35+
pip install ydb
3636

3737
Community
3838
=========

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
sphinx_rtd_theme==2.0.0
1+
sphinx_rtd_theme==2.0.0
2+
sphinx-copybutton==0.5.2

0 commit comments

Comments
 (0)