Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BarnabyShearer committed Aug 15, 2022
1 parent 802b732 commit 7684048
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ provider "readthedocs" {

### Optional

- **token** (String) API Token for authentication.
- `base_url` (String) ReadTheDocs API base URL. Can be used to target the Read The Docs For Business API.
- `token` (String) API Token for authentication.
26 changes: 14 additions & 12 deletions docs/resources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,26 @@ resource "readthedocs_project" "efm8" {

### Required

- **name** (String) Project name.
- **repository** (String) URL of repository to clone documentation from.
- `name` (String) Project name.
- `repository` (String) URL of repository to clone documentation from.

### Optional

- **analytics_code** (String) Google Analytics code for tracking views.
- **analytics_disabled** (Boolean) Disable Google Analytics.
- **default_branch** (String) Branch to build from.
- **default_version** (String) Version of documentation to show by default.
- **external_builds_enabled** (Boolean) Build PRs.
- **language** (String) Given like `en`, `fr` etc.
- **programming_language** (String) Given like `py`, `js` etc.
- **show_version_warning** (Boolean) Warn when viewing old versions.
- **single_version** (Boolean) Only show single version.
- `analytics_code` (String) Google Analytics code for tracking views.
- `analytics_disabled` (Boolean) Disable Google Analytics.
- `default_branch` (String) Branch to build from.
- `default_version` (String) Version of documentation to show by default.
- `external_builds_enabled` (Boolean) Build PRs.
- `language` (String) Given like `en`, `fr` etc.
- `organization` (String) ReadTheDocs for Business organization where the project should be created. Only valid when using Read The Docs for Business.
- `programming_language` (String) Given like `py`, `js` etc.
- `show_version_warning` (Boolean) Warn when viewing old versions.
- `single_version` (Boolean) Only show single version.
- `teams` (String) Team slugs the project will belong to. Only valid when using Read The Docs for Business.

### Read-Only

- **id** (String) The Slug of the project.
- `id` (String) The Slug of the project.

## Import

Expand Down

0 comments on commit 7684048

Please sign in to comment.