From 9e2812daacd58eae6f81e86cbce17c3077562c65 Mon Sep 17 00:00:00 2001 From: Qingping Hou Date: Thu, 25 May 2017 19:57:52 -0700 Subject: [PATCH] docs: remove redundant route docstring --- docs/Makefile | 6 +++--- src/oncall/api/v0/events.py | 2 -- src/oncall/api/v0/roster.py | 2 -- src/oncall/api/v0/roster_users.py | 2 -- src/oncall/api/v0/team_oncall.py | 2 -- src/oncall/api/v0/teams.py | 2 -- 6 files changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 76f6688..2230235 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -E SPHINXBUILD = sphinx-build SPHINXPROJ = Oncall SOURCEDIR = source @@ -17,8 +17,8 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) livehtml: - sphinx-autobuild -b html -H 0.0.0.0 --ignore '*~' "$(SOURCEDIR)" "$(BUILDDIR)/html" + sphinx-autobuild -b html -H 0.0.0.0 --ignore '*~' "$(SOURCEDIR)" "$(BUILDDIR)/html" -E diff --git a/src/oncall/api/v0/events.py b/src/oncall/api/v0/events.py index bd4e33e..154ea1d 100644 --- a/src/oncall/api/v0/events.py +++ b/src/oncall/api/v0/events.py @@ -65,8 +65,6 @@ constraints = { def on_get(req, resp): """ - http:get:: /api/v0/events - Search for events. Allows filtering based on a number of parameters, detailed below. **Example request**: diff --git a/src/oncall/api/v0/roster.py b/src/oncall/api/v0/roster.py index 7a126f4..768ba19 100644 --- a/src/oncall/api/v0/roster.py +++ b/src/oncall/api/v0/roster.py @@ -15,8 +15,6 @@ from ...utils import create_audit def on_get(req, resp, team, roster): """ - http:get:: /api/v0/teams/(str:team_name)/rosters - Get user and schedule info for a roster **Example request**: diff --git a/src/oncall/api/v0/roster_users.py b/src/oncall/api/v0/roster_users.py index 886cbb9..e1f13c7 100644 --- a/src/oncall/api/v0/roster_users.py +++ b/src/oncall/api/v0/roster_users.py @@ -14,8 +14,6 @@ from ...constants import ROSTER_USER_ADDED def on_get(req, resp, team, roster): """ - http:get:: /api/v0/teams/team-foo/rosters/roster-foo/users - Get all users for a team's roster **Example request**: diff --git a/src/oncall/api/v0/team_oncall.py b/src/oncall/api/v0/team_oncall.py index 5e7b511..201e9ef 100644 --- a/src/oncall/api/v0/team_oncall.py +++ b/src/oncall/api/v0/team_oncall.py @@ -23,8 +23,6 @@ get_oncall_query = ''' def on_get(req, resp, team, role): """ - http:get:: /api/v0/teams/(str:team_name)/oncall/(str:role) - Get current active event for team based on given role. **Example request**: diff --git a/src/oncall/api/v0/teams.py b/src/oncall/api/v0/teams.py index f86db89..c18fff9 100755 --- a/src/oncall/api/v0/teams.py +++ b/src/oncall/api/v0/teams.py @@ -24,8 +24,6 @@ constraints = { def on_get(req, resp): ''' - http:get:: /api/v0/teams - Search for team names. Allows filtering based on a number of parameters, detailed below. Returns list of matching team names. If "active" parameter is unspecified, defaults to True (only displaying undeleted teams)