Skip to content
This repository was archived by the owner on Sep 22, 2023. It is now read-only.

Docs for v20.03 with improved tutorials and quickstart guides #141

Draft
wants to merge 5 commits into
base: 20.03
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.6
version: 3.8
install:
- requirements: requirements/docs.txt
1 change: 1 addition & 0 deletions changes/141.docs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Docs for v20.03 with improved tutorials and CLI quickstart guide.
18 changes: 10 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@
_init_path = (Path(__file__).parent.parent / 'src' /
'ai' / 'backend' / 'client' / '__init__.py')
_init_text = _init_path.read_text()
try:
_version_info = re.search(
r"^__version__ = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<tag>.*)?'$", # noqa
_init_text, re.M).groupdict()
except IndexError:
_version_info = None
_m = re.search(
r"^__version__ = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<tag>.*)?'$",
_init_text, re.M)
if _m is not None:
_version_info = _m.groupdict()
else:
raise RuntimeError('Unable to determine version.')


Expand All @@ -34,14 +36,14 @@
try:
from ai.backend.client import request # noqa
except ImportError:
subprocess.run('pip install -U "pip>=19.2" "setuptools>=41.2"', shell=True)
subprocess.run('pip install -e "..[docs]"', shell=True)
subprocess.run('pip install -U "pip>=20.2" "setuptools>=50.3"', shell=True)
subprocess.run('pip install -r "requirements/docs.txt"', shell=True)


# -- Project information -----------------------------------------------------

project = 'Backend.AI Client SDK for Python'
copyright = '2019, Lablup Inc.'
copyright = '2020, Lablup Inc.'
author = 'Lablup Inc.'

# The short X.Y version.
Expand Down
Binary file added docs/gsg/jupyter_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gsg/jupyter_mnist_execution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
479 changes: 479 additions & 0 deletions docs/gsg/quickstart.rst

Large diffs are not rendered by default.

Binary file added docs/gsg/ttyd_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Getting Started

gsg/installation
gsg/config
gsg/quickstart

Command-line Interface
----------------------
Expand Down