Skip to content

Switch to using typedoc for TypeScript documentation. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.PHONY: default
default: banner build
default: banner generate build

.PHONY: all
all: banner build
all: banner generate build

.PHONY: banner
banner:
Expand All @@ -15,7 +15,13 @@ serve:
@echo -e "\033[0;32mSERVE:\033[0m"
bundler exec jekyll serve

.PHONY: generate
generate:
@echo -e "\033[0;32mGENERATE:\033[0m"
./scripts/run_typedoc.sh

.PHONY: build
build:
@echo -e "\033[0;32mBUILD:\033[0m"
bundle install
bundler exec jekyll build
25 changes: 12 additions & 13 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ plugins:

# Files to not include when building.
exclude:
- scripts
- .gitignore
- Gemfile
- Gemfile.lock
- Makefile
- README.md

# Jekyll collections. This is how we specify our TypeScript docs, allowing us
# to do filtering at generation-time.
collections:
typescript_docs:
output: true
permalink: /typescript/:path/
- scripts
- .gitignore
- Gemfile
- Gemfile.lock
- Makefile
- README.md

# Totally lame workaround until typedoc emits files withouty a leading
# underscore or we have our own TypeScript documentation generation stack.
# https://github.com/TypeStrong/typedoc/issues/149
include:
- _*

2 changes: 1 addition & 1 deletion _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<a class="nav-link" href="/examples">Examples</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#">Framework</a>
<a class="nav-link" href="/libraries">Libraries</a>
</li>
</ul>
</div>
Expand Down
24 changes: 0 additions & 24 deletions _layouts/typescript-reference.html

This file was deleted.

17 changes: 0 additions & 17 deletions _layouts/typescript-repo.html

This file was deleted.

17 changes: 0 additions & 17 deletions _typescript_docs/pulumi-aws/apigateway/account.d.ts

This file was deleted.

30 changes: 0 additions & 30 deletions _typescript_docs/pulumi-aws/apigateway/apiKey.d.ts

This file was deleted.

28 changes: 0 additions & 28 deletions _typescript_docs/pulumi-aws/apigateway/authorizer.d.ts

This file was deleted.

20 changes: 0 additions & 20 deletions _typescript_docs/pulumi-aws/apigateway/basePathMapping.d.ts

This file was deleted.

16 changes: 0 additions & 16 deletions _typescript_docs/pulumi-aws/apigateway/clientCertificate.d.ts

This file was deleted.

29 changes: 0 additions & 29 deletions _typescript_docs/pulumi-aws/apigateway/deployment.d.ts

This file was deleted.

26 changes: 0 additions & 26 deletions _typescript_docs/pulumi-aws/apigateway/domainName.d.ts

This file was deleted.

48 changes: 0 additions & 48 deletions _typescript_docs/pulumi-aws/apigateway/integration.d.ts

This file was deleted.

38 changes: 0 additions & 38 deletions _typescript_docs/pulumi-aws/apigateway/integrationResponse.d.ts

This file was deleted.

Loading