Skip to content

Commit 82639c8

Browse files
ivan-khomyakov-scivan-khomyakov-sc
authored
Sphinx documentation (#16)
* sphinx documentation * try to commit full page * reorg docs folder * rename static * dont use jekyll * update readme * change image url * ignore sources * ignore doctree
1 parent cabbc22 commit 82639c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+25540
-11
lines changed

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@
66
**/.idea/
77
**/scratch/
88
*.swp
9-
.vim/
9+
.vim/
10+
11+
# Sphinx documentation
12+
docs/_sources
13+
docs/.doctrees

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Scale Launch provides ML engineers a simple Python interface for turning a local
1313
A ML engineer needs to call a few functions from Scale's SDK, which quickly spins up a production-ready service.
1414
The service efficiently utilizes compute resources and automatically scales according to traffic.
1515

16+
Latest API/SDK reference can be found [here](https://scaleapi.github.io/launch-python-client/).
17+
1618
## Deploying your model via Scale Launch
1719

1820
Central to Scale Launch are the notions of a `ModelBundle` and a `ModelEndpoint`.
@@ -49,3 +51,18 @@ Please install the pre-commit hooks by running the following command:
4951
```bash
5052
poetry run pre-commit install
5153
```
54+
55+
### Documentation
56+
57+
**Updating documentation:**
58+
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to autogenerate our API Reference from docstrings.
59+
60+
To test your local docstring changes, run the following commands from the repository's root directory:
61+
62+
```
63+
poetry shell
64+
cd src_docs
65+
sphinx-autobuild . ../docs --watch ../launch
66+
```
67+
68+
`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.

‎docs/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 1607844cab78a028e790040392646acc
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.nojekyll‎

Whitespace-only changes.

docs/images/model_bundle.png renamed to docs/_images/model_bundle.png

File renamed without changes.

docs/images/model_endpoint.png renamed to docs/_images/model_endpoint.png

File renamed without changes.

docs/images/request_lifecycle.png renamed to docs/_images/request_lifecycle.png

File renamed without changes.

0 commit comments

Comments
 (0)