Skip to content
This repository has been archived by the owner on Oct 30, 2024. It is now read-only.

New configuration package for TypeDoc documentation #11

Closed
holgerd77 opened this issue Jan 10, 2019 · 1 comment
Closed

New configuration package for TypeDoc documentation #11

holgerd77 opened this issue Jan 10, 2019 · 1 comment

Comments

@holgerd77
Copy link
Member

holgerd77 commented Jan 10, 2019

Since auto-generated documentation is applied on most of the libraries (and probably should be extended to all), we should also add a config package for documentation here.

The util package TypeScript PR ethereumjs/ethereumjs-util#170 already gives some boilerplate/template for TypeDoc usage, there should also be some common npm script, see #10.

Note: Configuration file docs for TypeDoc is a bit hard to find, here is some entry point.

@holgerd77
Copy link
Member Author

Note:
Package name should be tool agnostic, so ethereumjs-config-docs.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant