Skip to content

Commit a839aab

Browse files
woopwoop
committed
Built documentation for Python SDK
1 parent 22f5d2b commit a839aab

117 files changed

Lines changed: 35593 additions & 7 deletions

File tree

Some content is hidden

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

‎sdk/python/docs/Makefile‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,32 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = Feast
8-
SOURCEDIR = source
9-
BUILDDIR = build
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = Feast
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
PROJECT_ROOT := $(shell git rev-parse --show-toplevel)
1011

1112
# Put it first so that "make" without argument is like "make help".
1213
help:
1314
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1415

1516
.PHONY: help Makefile source
1617

17-
source:
18-
sphinx-apidoc -f -o source ../feast
18+
clean:
19+
rm -rf $(PROJECT_ROOT)/sdk/python/feast/docs/source
20+
rm -rf $(PROJECT_ROOT)/sdk/python/feast/docs/build
21+
22+
build-api-source:
23+
sphinx-apidoc -f -o source $(PROJECT_ROOT)/sdk/python/feast
24+
25+
build-html-docs: build-api-source
26+
sphinx-build -b html source build
27+
28+
html: build-html-docs
29+
mkdir -p $(PROJECT_ROOT)/dist/python
30+
mv $(PROJECT_ROOT)/sdk/python/docs/build/html/* $(PROJECT_ROOT)/dist/python/
1931

2032
# Catch-all target: route all unknown targets to Sphinx using the new
2133
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

‎sdk/python/docs/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Documentation Release Process
2+
3+
```
4+
# you can avoid this line if you are in master...
5+
git checkout master
6+
7+
# create a local gh-pages branch containing the splitted output folder
8+
git subtree split --prefix dist -b gh-pages
9+
10+
# force the push of the gh-pages branch to the remote gh-pages branch at origin
11+
git push -f origin gh-pages:gh-pages
12+
13+
# delete the local gh-pages because you will need it: ref
14+
git branch -D gh-pages
15+
```

‎sdk/python/docs/html/.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: 1e0949787c45bded0b049cd50fe23d26
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎sdk/python/docs/html/.doctrees/environment.pickle‎

1.88 MB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.core.doctree‎

169 KB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.doctree‎

180 KB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.loaders.doctree‎

26.5 KB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.serving.doctree‎

114 KB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.storage.doctree‎

9.22 KB
Binary file not shown.

‎sdk/python/docs/html/.doctrees/feast.types.doctree‎

108 KB
Binary file not shown.

0 commit comments

Comments
 (0)