Skip to content

Commit

Permalink
Fix documentation building for ReadTheDocs
Browse files Browse the repository at this point in the history
Signed-off-by: Willem Pienaar <git@willem.co>
  • Loading branch information
woop committed Mar 28, 2021
1 parent 3b6d993 commit b667df1
Show file tree
Hide file tree
Showing 14 changed files with 34 additions and 34 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@ dmypy.json
*.code-workspace

# Protos
sdk/python/docs/source
sdk/python/docs/html
sdk/python/feast/protos/
sdk/go/protos/
4 changes: 1 addition & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@ formats:
python:
version: 3.7
install:
- requirements: sdk/python/docs/requirements.txt
- path: sdk/python/
method: setuptools
- requirements: sdk/python/docs/requirements.txt
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
[![integration-tests](https://github.com/feast-dev/feast/actions/workflows/integration_tests.yml/badge.svg?branch=master&event=push)](https://github.com/feast-dev/feast/actions/workflows/integration_tests.yml)
[![linter](https://github.com/feast-dev/feast/actions/workflows/linter.yml/badge.svg?branch=master&event=push)](https://github.com/feast-dev/feast/actions/workflows/linter.yml)
[![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.feast.dev/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/feast-dev/feast/blob/master/LICENSE)
[![Python API](https://img.shields.io/readthedocs/feast/master?label=Python%20API)](http://rtd.feast.dev/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/feast-dev/feast/blob/master/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/feast-dev/feast.svg?style=flat&sort=semver&color=blue)](https://github.com/feast-dev/feast/releases)

## Overview
Expand Down
5 changes: 1 addition & 4 deletions sdk/python/docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,10 @@ help:

.PHONY: help Makefile source

clean-source:
rm -rf $(PROJECT_ROOT)/sdk/python/docs/source

clean-html:
rm -rf $(PROJECT_ROOT)/sdk/python/docs/html

build-api-source: clean-source
build-api-source:
sphinx-apidoc -f -o source $(PROJECT_ROOT)/sdk/python/feast
cp conf.py index.rst source/

Expand Down
34 changes: 18 additions & 16 deletions sdk/python/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
Feast Python API Documentation
=============================

Client

Feature Store
---------------------------

.. automodule:: feast.feature_store
:members:
:undoc-members:
:show-inheritance:

Config
==================

.. automodule:: feast.client
.. automodule:: feast.repo_config
:members:
:exclude-members: load_repo_config

Data Source
==================
Expand All @@ -22,6 +32,12 @@ Entity
:members:


Feature View
==================

.. automodule:: feast.feature_view
:members:

Feature Table
==================

Expand All @@ -34,17 +50,3 @@ Feature
.. automodule:: feast.feature
:inherited-members:
:members:

Constants
==================

.. automodule:: feast.constants
:members:
:exclude-members: AuthProvider, ConfigMeta

Config
==================

.. automodule:: feast.repo_config
:members:
:exclude-members: load_repo_config
3 changes: 2 additions & 1 deletion sdk/python/docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ grpcio-tools==1.31.0
mypy==0.790
mypy-protobuf==1.24
firebase-admin==4.5.2
google-cloud-datastore==2.1.0
google-cloud-datastore==2.1.0
-e "./sdk/python/[ci]"
File renamed without changes.
Empty file.
Empty file.
Empty file.
18 changes: 10 additions & 8 deletions sdk/python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,14 @@

try:
from setuptools import setup
from setuptools.command.install import install
from setuptools.command.develop import develop
from setuptools.command.egg_info import egg_info
from setuptools.command.sdist import sdist
from setuptools.command.build_py import build_py
except ImportError:
from distutils.core import setup
from distutils.command.install import install
from distutils.command.build_py import build_py

NAME = "feast"
Expand All @@ -35,6 +39,8 @@

REQUIRED = [
"Click==7.*",
"bindr",
"fastavro>=0.22.11,<0.23",
"google-api-core>=1.23.0",
"google-cloud-bigquery>=2.0.*",
"google-cloud-bigquery-storage >= 2.0.0",
Expand All @@ -43,20 +49,17 @@
"googleapis-common-protos==1.52.*",
"grpcio==1.31.0",
"Jinja2>=2.0.0",
"jsonschema",
"mmh3",
"numpy<1.20.0",
"pandas~=1.0.0",
"pandavro==1.5.*",
"protobuf>=3.10",
"pyarrow==2.0.0",
"PyYAML==5.3.*",
"fastavro>=0.22.11,<0.23",
"tabulate==0.8.*",
"toml==0.10.*",
"tqdm==4.*",
"pyarrow==2.0.0",
"numpy<1.20.0",
"google",
"bindr",
"mmh3",
"jsonschema",
]

CI_REQUIRED = [
Expand Down Expand Up @@ -176,7 +179,6 @@ def run(self):
# Install dev requirements with: pip install -e .[dev]
extras_require={
"dev": ["mypy-protobuf==1.*", "grpcio-testing==1.*"],
"docs": ["grpcio-tools"],
"ci": CI_REQUIRED
},
include_package_data=True,
Expand Down
Empty file.
Empty file.
Empty file.

0 comments on commit b667df1

Please sign in to comment.