Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

Commit

Permalink
Merge pull request #2988 from mozilla/pb/disable-docs-generation
Browse files Browse the repository at this point in the history
#2988
r=vladikoff
  • Loading branch information
philbooth authored Mar 25, 2019
2 parents 6956f1d + 66302e1 commit 8a6490e
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 1,106 deletions.
34 changes: 0 additions & 34 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Firefox Accounts authentication server API

This document is automatically generated.
If you are editing it,
read [this section](#this-document) first.

<!--begin-abstract-->
This document provides protocol-level details
of the Firefox Accounts auth server API.
Expand Down Expand Up @@ -94,7 +90,6 @@ see [`mozilla/fxa-js-client`](https://github.com/mozilla/fxa-js-client).
* [GET /complete_reset_password](#get-complete_reset_password)
* [Example flows](#example-flows)
* [Back-off protocol](#back-off-protocol)
* [This document](#this-document)

## Overview

Expand Down Expand Up @@ -3111,32 +3106,3 @@ Content-Type: application/json
}
```
<!--end-back-off-protocol-->

## This document
<!--begin-this-document-->
This document is automatically generated
by [a script](../scripts/write-api-docs.js)
that parses the source code
and the document itself.

All changes to this document will be lost
unless they are made inside
delimiting HTML comments of the form:
```html
<!--begin-foo-bar-->
YOUR CHANGE GOES HERE
<!--end-foo-bar->
```
`foo-bar` must be a tag
that, when camel-cased,
matches a property name in the data
for the [mustache template](../scripts/api-docs.mustache)
this document is generated from.
If you want to change
the structure of the document,
you must make your changes
to `scripts/api-docs.mustache`
rather than in this document directly.
<!--end-this-document-->
31 changes: 0 additions & 31 deletions grunttasks/doc.js

This file was deleted.

3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
"scripts": {
"bump-template-versions": "node scripts/template-version-bump --silent && git add lib/senders/templates/_versions.json",
"lint:deps": "npm audit --json | audit-filter --nsp-config=.nsprc --audit=-",
"update-api-docs": "grunt newer:doc && git add docs/api.md",
"precommit": "npm run bump-template-versions && npm run update-api-docs",
"precommit": "npm run bump-template-versions",
"postinstall": "scripts/download_l10n.sh",
"shrink": "npmshrink && npm run postinstall",
"start": "NODE_ENV=dev scripts/start-local.sh 2>&1",
Expand Down
Loading

0 comments on commit 8a6490e

Please sign in to comment.