Skip to content

Commit 8b8390f

Browse files
woopwoop
committed
Update hooks and documentation building
Signed-off-by: Willem Pienaar <git@willem.co>
1 parent f543871 commit 8b8390f

File tree

12 files changed

+91
-77
lines changed

12 files changed

+91
-77
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ default_stages:
33
repos:
44
- repo: local
55
hooks:
6+
- id: format
7+
name: Format
8+
stages: [ push ]
9+
language: system
10+
entry: make format
611
- id: lint
712
name: Lint
813
stages: [ push ]

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Development Guide: Main Feast Repository
2-
> The higher level [Development Guide](https://docs.feast.dev/contributing/development-guide)
3-
> gives guidance on contributing to Feast codebase as a whole.
2+
> Please see [Development Guide](https://docs.feast.dev/contributing/development-guide) for project level development instructions.
43
54
### Overview
65
This guide is targeted at developers looking to contribute to Feast components in
@@ -9,25 +8,20 @@ the main Feast repository:
98
- [Feast Go Client](#feast-go-client)
109
- [Feast Terraform](#feast-terraform)
1110

12-
> Don't see the Feast component that you want to contribute to here?
13-
> Check out the
14-
> [Development Guide](https://docs.feast.dev/contributing/development-guide)
15-
> to learn how Feast components are distributed over multiple repositories.
16-
1711
### Pre-commit Hooks
1812
Setup [`pre-commit`](https://pre-commit.com/) to automatically lint and format the codebase on commit:
19-
1. Ensure that you have Python (3.6 and above) with `pip`, installed.
20-
2. Install `pre-commit` with `pip` &amp; install pre-commit hooks
13+
1. Ensure that you have Python (3.7 and above) with `pip`, installed.
14+
2. Install `pre-commit` with `pip` &amp; install pre-push hooks
2115
```sh
2216
pip install pre-commit
23-
pre-commit install
17+
pre-commit install --hook-type pre-push
2418
```
25-
3. On commit, the pre-commit hook will run.
19+
3. On push, the pre-commit hook will run. This runs `make format` and `make lint`.
2620

2721
## Feast Python SDK / CLI
2822
### Environment Setup
2923
Setting up your development environment for Feast Python SDK / CLI:
30-
1. Ensure that you have `make`, Python (3.6 and above) with `pip`, installed.
24+
1. Ensure that you have `make`, Python (3.7 and above) with `pip`, installed.
3125
2. _Recommended:_ Create a virtual environment to isolate development dependencies to be installed
3226
```sh
3327
# create & activate a virtual environment

‎infra/netlify/requirements.txt‎

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

‎infra/netlify/runtime.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎sdk/python/docs/Makefile‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ build-api-source:
2424

2525
html: clean-html build-api-source
2626
sphinx-build -b html source html
27-
rm -rf $(PROJECT_ROOT)/sdk/python/docs/source
2827

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

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

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
feast.infra.offline\_stores package
2+
===================================
3+
4+
Submodules
5+
----------
6+
7+
feast.infra.offline\_stores.bigquery module
8+
-------------------------------------------
9+
10+
.. automodule:: feast.infra.offline_stores.bigquery
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
feast.infra.offline\_stores.file module
16+
---------------------------------------
17+
18+
.. automodule:: feast.infra.offline_stores.file
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
feast.infra.offline\_stores.helpers module
24+
------------------------------------------
25+
26+
.. automodule:: feast.infra.offline_stores.helpers
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
feast.infra.offline\_stores.offline\_store module
32+
-------------------------------------------------
33+
34+
.. automodule:: feast.infra.offline_stores.offline_store
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: feast.infra.offline_stores
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
feast.infra package
22
===================
33

4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
feast.infra.offline_stores
11+
412
Submodules
513
----------
614

@@ -20,10 +28,10 @@ feast.infra.key\_encoding\_utils module
2028
:undoc-members:
2129
:show-inheritance:
2230

23-
feast.infra.local\_sqlite module
24-
--------------------------------
31+
feast.infra.local module
32+
------------------------
2533

26-
.. automodule:: feast.infra.local_sqlite
34+
.. automodule:: feast.infra.local
2735
:members:
2836
:undoc-members:
2937
:show-inheritance:

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

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ feast.entity module
7979
:undoc-members:
8080
:show-inheritance:
8181

82-
feast.example\_repo module
83-
--------------------------
82+
feast.errors module
83+
-------------------
8484

85-
.. automodule:: feast.example_repo
85+
.. automodule:: feast.errors
8686
:members:
8787
:undoc-members:
8888
:show-inheritance:
@@ -127,14 +127,6 @@ feast.names module
127127
:undoc-members:
128128
:show-inheritance:
129129

130-
feast.offline\_store module
131-
---------------------------
132-
133-
.. automodule:: feast.offline_store
134-
:members:
135-
:undoc-members:
136-
:show-inheritance:
137-
138130
feast.online\_response module
139131
-----------------------------
140132

@@ -183,6 +175,14 @@ feast.type\_map module
183175
:undoc-members:
184176
:show-inheritance:
185177

178+
feast.utils module
179+
------------------
180+
181+
.. automodule:: feast.utils
182+
:members:
183+
:undoc-members:
184+
:show-inheritance:
185+
186186
feast.value\_type module
187187
------------------------
188188

@@ -191,6 +191,14 @@ feast.value\_type module
191191
:undoc-members:
192192
:show-inheritance:
193193

194+
feast.version module
195+
--------------------
196+
197+
.. automodule:: feast.version
198+
:members:
199+
:undoc-members:
200+
:show-inheritance:
201+
194202
feast.wait module
195203
-----------------
196204

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

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ Config
1515

1616
.. automodule:: feast.repo_config
1717
:members:
18-
:exclude-members: load_repo_config
18+
:exclude-members: load_repo_config, FeastBaseModel
1919

2020
Data Source
2121
==================
2222

2323
.. automodule:: feast.data_source
2424
:members:
25+
:exclude-members: KafkaOptions, KafkaSource, KinesisOptions, KinesisSource
2526

2627

2728
Entity
@@ -38,12 +39,6 @@ Feature View
3839
.. automodule:: feast.feature_view
3940
:members:
4041

41-
Feature Table
42-
==================
43-
44-
.. automodule:: feast.feature_table
45-
:members:
46-
4742
Feature
4843
==================
4944

‎sdk/python/tensorflow_metadata/proto/v0/path_pb2.py‎

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

0 commit comments

Comments
 (0)