Skip to content

Commit b5d6bf9

Browse files
committed
renaming api_docs to reference
1 parent 87a0d82 commit b5d6bf9

16 files changed

Lines changed: 23 additions & 55 deletions

docs/source/api_doc/vetiver.pin_read_write.rst

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,12 @@
6060
"use_repository_button": True,
6161
"use_issues_button": True,
6262
"use_edit_page_button": True,
63+
"home_page_in_toc": True
6364

6465
}
6566

6667
html_logo = "../figures/logo.png"
68+
html_favicon = "../figures/logo.png"
6769

6870

6971
# Add any paths that contain custom static files (such as style sheets) here,

docs/source/index.rst

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
.. vetiver documentation master file, created by
2-
sphinx-quickstart on Thu Mar 3 14:13:21 2022.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
6-
vetiver
1+
vetiver 🏺
72
===================================
83
The goal of vetiver is to provide fluent tooling to version, share, deploy, and monitor a trained model. Functions handle both recording and checking the model’s input data prototype, and predicting from a remote API endpoint.
94
You can use vetiver with:
105

11-
- scikit-learn
12-
- pytorch
6+
- `scikit-learn <https://scikit-learn.org/stable/>`_
7+
- `pytorch <https://pytorch.org/>`_
8+
9+
This website documents the public API of Vetiver (for Python). See the `main Vetiver website <https://juliasilge.github.io/vetiver.dev/>`_ for
10+
a more holistic introduction to the API. The left-hand sidebar lists the full public
11+
API, and the sections below (linked to the right-hand sidebar) break it into similar groups, based on task.
1312

1413
.. toctree::
1514
:maxdepth: 2
1615
:caption: Contents:
1716

18-
1917
Version
2018
==================
2119

2220
.. currentmodule:: vetiver
2321

2422
.. autosummary::
25-
:toctree: api_doc/
23+
:toctree: reference/
24+
:caption: Version
2625

2726
~VetiverModel
2827
~pin_read_write.vetiver_pin_read
@@ -34,24 +33,14 @@ Deploy
3433
.. currentmodule:: vetiver
3534

3635
.. autosummary::
37-
:toctree: api_doc/
38-
39-
~VetiverModel
40-
41-
Deploy
42-
==================
43-
44-
.. currentmodule:: vetiver
45-
46-
.. autosummary::
47-
:toctree: api_doc/
48-
49-
~VetiverModel
36+
:toctree: reference/
37+
:caption: Deploy
5038

5139
~VetiverAPI
5240
~VetiverAPI.run
5341
~VetiverAPI.vetiver_post
5442
~vetiver_endpoint
43+
~predict
5544
~load_pkgs
5645
~vetiver_write_app
57-
~vetiver_write_docker
46+
~vetiver_write_docker
File renamed without changes.
File renamed without changes.

docs/source/api_doc/vetiver.VetiverAPI.vetiver_post.rst renamed to docs/source/reference/vetiver.VetiverAPI.vetiver_post.rst

File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/source/api_doc/vetiver.pin_read_write.vetiver_pin_read.rst renamed to docs/source/reference/vetiver.pin_read_write.vetiver_pin_read.rst

File renamed without changes.

docs/source/api_doc/vetiver.pin_read_write.vetiver_pin_write.rst renamed to docs/source/reference/vetiver.pin_read_write.vetiver_pin_write.rst

File renamed without changes.

0 commit comments

Comments
 (0)