Skip to content

Commit 0fcf08e

Browse files
woopwoop
committed
Fix Python documentation building
1 parent 00d5c54 commit 0fcf08e

15 files changed

Lines changed: 49 additions & 364 deletions

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@ clean-html:
4848

4949
build-html:
5050
mkdir -p $(PROJECT_ROOT)/dist/python
51+
cd $(PROJECT_ROOT)/sdk/python/docs && $(MAKE) html
5152
cp -r $(PROJECT_ROOT)/sdk/python/docs/html/* $(PROJECT_ROOT)/dist/python

‎sdk/python/docs/Makefile‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ help:
1717

1818
clean:
1919
rm -rf $(PROJECT_ROOT)/sdk/python/docs/html
20-
rm -rf $(PROJECT_ROOT)/sdk/python/docs/build
20+
rm -rf $(PROJECT_ROOT)/sdk/python/docs/source
2121

2222
build-api-source:
2323
sphinx-apidoc -f -o source $(PROJECT_ROOT)/sdk/python/feast
24+
cp conf.py index.rst source/
2425

2526
html: clean build-api-source
2627
sphinx-build -b html source html
28+
rm -rf $(PROJECT_ROOT)/sdk/python/docs/source
2729

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

sdk/python/docs/source/conf.py renamed to sdk/python/docs/conf.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
import sphinx_rtd_theme
2222

2323

24-
sys.path.insert(0, os.path.abspath("../feast"))
24+
sys.path.insert(0, os.path.abspath("../../feast"))
25+
sys.path.insert(0, os.path.abspath("../.."))
2526

2627

2728
# -- General configuration ------------------------------------------------
@@ -69,9 +70,15 @@
6970
# built documents.
7071
#
7172
# The short X.Y version.
72-
version = u"0.3.2"
73+
74+
# TODO: Add the below versions back to documentation building.
75+
# version = (
76+
# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip()
77+
# )
7378
# The full version, including alpha/beta/rc tags.
74-
release = u"0.3.2"
79+
# release = (
80+
# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip()
81+
# )
7582

7683
# The language for content autogenerated by Sphinx. Refer to documentation
7784
# for a list of supported languages.

sdk/python/docs/source/index.rst renamed to sdk/python/docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@ Feature
1919
==================
2020

2121
.. automodule:: feast.feature
22+
:inherited-members:
2223
:members:
2324

2425

2526
Entity
2627
==================
2728

2829
.. automodule:: feast.entity
30+
:inherited-members:
2931
:members:
3032

3133

‎sdk/python/docs/requirements.txt‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
google-api-core==1.*
2+
google-auth==1.*
3+
google-cloud-bigquery==1.*
4+
google-cloud-bigquery-storage==0.*
5+
google-cloud-storage==1.*
6+
google-resumable-media>=0.5
7+
googleapis-common-protos==1.*
8+
grpcio==1.*
9+
numpy
10+
mock==2.0.0
11+
pandas==0.*
12+
protobuf==3.*
13+
pytest
14+
pytest-mock
15+
pytest-timeout
16+
PyYAML==5.1.2
17+
fastavro==0.21.*
18+
grpcio-testing==1.*
19+
pytest-ordering==0.6.*
20+
pyarrow
21+
Sphinx==2.*
22+
sphinx-autodoc-napoleon-typehints
23+
sphinx-autodoc-typehints
24+
sphinx-rtd-theme
25+
sphinxcontrib-applehelp
26+
sphinxcontrib-devhelp
27+
sphinxcontrib-htmlhelp
28+
sphinxcontrib-jsmath
29+
sphinxcontrib-napoleon
30+
sphinxcontrib-qthelp
31+
sphinxcontrib-serializinghtml

‎sdk/python/docs/runtime.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.7

‎sdk/python/docs/source/feast.core.rst‎

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

‎sdk/python/docs/source/feast.loaders.rst‎

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

‎sdk/python/docs/source/feast.rst‎

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

‎sdk/python/docs/source/feast.serving.rst‎

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

0 commit comments

Comments
 (0)