Skip to content

Commit 6de3932

Browse files
woopwoop
committed
Update Makefile for building Python API docs
1 parent a839aab commit 6de3932

File tree

8 files changed

+19
-28
lines changed

8 files changed

+19
-28
lines changed

‎Makefile‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
15-
#
15+
#
16+
17+
PROJECT_ROOT := $(shell git rev-parse --show-toplevel)
1618

1719
test:
1820
mvn test
@@ -39,4 +41,12 @@ build-docker:
3941
build-push-docker:
4042
@$(MAKE) build-docker registry=$(REGISTRY) version=$(VERSION)
4143
docker push $(REGISTRY)/feast-core:$(VERSION)
42-
docker push $(REGISTRY)/feast-serving:$(VERSION)
44+
docker push $(REGISTRY)/feast-serving:$(VERSION)
45+
46+
clean-html:
47+
rm -rf $(PROJECT_ROOT)/dist
48+
49+
build-html:
50+
mkdir -p $(PROJECT_ROOT)/dist/python
51+
cd $(PROJECT_ROOT)/sdk/python/docs && $(MAKE) html
52+
cp -r $(PROJECT_ROOT)/sdk/python/docs/html/* $(PROJECT_ROOT)/dist/python

‎sdk/python/docs/Makefile‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,14 @@ help:
1616
.PHONY: help Makefile source
1717

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

2222
build-api-source:
2323
sphinx-apidoc -f -o source $(PROJECT_ROOT)/sdk/python/feast
2424

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/
25+
html: clean build-api-source
26+
sphinx-build -b html source html
3127

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

‎sdk/python/docs/README.md‎

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

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

0 Bytes
Binary file not shown.

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

0 Bytes
Binary file not shown.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -880,7 +880,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
880880

881881
<dl class="function">
882882
<dt id="feast.type_map.convert_dict_to_proto_values">
883-
<code class="sig-prename descclassname">feast.type_map.</code><code class="sig-name descname">convert_dict_to_proto_values</code><span class="sig-paren">(</span><em class="sig-param">row: dict</em>, <em class="sig-param">df_datetime_dtype: &lt;property object at 0x7fd7d44a6cc8&gt;</em>, <em class="sig-param">feature_set</em><span class="sig-paren">)</span> &#x2192; feast.types.FeatureRow_pb2.FeatureRow<a class="reference internal" href="_modules/feast/type_map.html#convert_dict_to_proto_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#feast.type_map.convert_dict_to_proto_values" title="Permalink to this definition"></a></dt>
883+
<code class="sig-prename descclassname">feast.type_map.</code><code class="sig-name descname">convert_dict_to_proto_values</code><span class="sig-paren">(</span><em class="sig-param">row: dict</em>, <em class="sig-param">df_datetime_dtype: &lt;property object at 0x7fdaea738868&gt;</em>, <em class="sig-param">feature_set</em><span class="sig-paren">)</span> &#x2192; feast.types.FeatureRow_pb2.FeatureRow<a class="reference internal" href="_modules/feast/type_map.html#convert_dict_to_proto_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#feast.type_map.convert_dict_to_proto_values" title="Permalink to this definition"></a></dt>
884884
<dd><p>Encode a dictionary describing a feature row into a FeatureRows object.</p>
885885
<dl class="field-list simple">
886886
<dt class="field-odd">Parameters</dt>

‎sdk/python/docs/html/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/python/docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
# further. For a list of options available for each theme, see the
104104
# documentation.
105105
#
106-
html_theme_options = {"font_size": "15px"}
106+
html_theme_options = {}
107107

108108
# Add any paths that contain custom static files (such as style sheets) here,
109109
# relative to this directory. They are copied after the builtin static files,

0 commit comments

Comments
 (0)