Skip to content

Commit 3a85371

Browse files
committed
restructure docs
1 parent 819bc44 commit 3a85371

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

docs/ydb.rst renamed to docs/apireference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
ydb
2-
===
1+
YDB API Reference
2+
=================
33

44
.. toctree::
55
:caption: Contents:

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ YDB Python SDK
77
===============================
88

99
.. toctree::
10-
:maxdepth: 4
10+
:maxdepth: 3
1111

1212
overview
13-
ydb.rst
14-
examples.rst
13+
examples
14+
apireference
1515

1616

1717
Indices and tables

docs/overview.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
Overview
2+
========
3+
14
Project Homepage
2-
================
5+
----------------
36

47
YDB Python SDK is hosted on GitHub at https://github.com/ydb-platform/ydb-python-sdk under the ydb-platform organization.
58

@@ -8,10 +11,10 @@ Releases and project status are available on Pypi at https://pypi.org/project/yd
811
The most recent published version of this documentation should be at https://ydb-platform.github.io/ydb-python-sdk.
912

1013
Installation
11-
============
14+
------------
1215

1316
Prerequisites
14-
-------------
17+
^^^^^^^^^^^^^
1518

1619
* Python 3.8 or higher;
1720
* ``pip`` version 9.0.1 or higher;
@@ -28,14 +31,14 @@ If you cannot upgrade `pip` due to a system-owned installation, you can run the
2831
python -m pip install --upgrade pip
2932

3033
Installation via Pypi
31-
---------------------
34+
^^^^^^^^^^^^^^^^^^^^^
3235

3336
To install YDB Python SDK through Pypi execute the following command::
3437

3538
pip install ydb
3639

3740
Community
38-
=========
41+
---------
3942

4043
You can ask your questions in official Telegram chats:
4144

0 commit comments

Comments
 (0)