Skip to content

Commit 64f8473

Browse files
achingbrainachingbrain
authored
docs: publish api docs (#181)
Update project config to publish api docs
1 parent e583cce commit 64f8473

File tree

15 files changed

+127
-54
lines changed

15 files changed

+127
-54
lines changed

‎.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
node_modules
12
dist
3+
.docs
4+
.coverage
25
node_modules
36
package-lock.json
4-
docs
5-
types
6-
.nyc_output
7-
*.log
7+
yarn.lock

‎.npmrc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
engine-strict = true
1+
; package-lock with tarball deps breaks lerna/nx - remove when https://github.com/semantic-release/github/pull/487 is merged
2+
package-lock=false

‎README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# ipfs-interfaces <!-- omit in toc -->
22

3-
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4-
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5-
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
3+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
4+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
65
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
7-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
87

98
> TypeScript interfaces used by IPFS internals
109
@@ -13,6 +12,7 @@
1312
- [Structure](#structure)
1413
- [Packages](#packages)
1514
- [Contribute](#contribute)
15+
- [API Docs](#api-docs)
1616
- [License](#license)
1717
- [Contribute](#contribute-1)
1818

@@ -36,6 +36,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
3636

3737
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
3838

39+
## API Docs
40+
41+
- <https://ipfs.github.io/js-ipfs-interfaces>
42+
3943
## License
4044

4145
Licensed under either of
@@ -45,8 +49,12 @@ Licensed under either of
4549

4650
## Contribute
4751

48-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
52+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
4953

50-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
54+
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
55+
56+
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
57+
58+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
5159

5260
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎lerna.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
{
2-
"lerna": "4.0.0",
2+
"lerna": "6.0.0",
33
"useWorkspaces": true,
44
"version": "independent",
55
"command": {
66
"run": {
77
"stream": true
88
}
9-
},
10-
"packages": [
11-
"packages/*"
12-
]
9+
}
1310
}

‎package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,13 @@
2929
"clean": "lerna run clean",
3030
"build": "lerna run build",
3131
"lint": "lerna run lint",
32+
"docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
33+
"docs:no-publish": "npm run docs -- --publish false",
3234
"dep-check": "lerna run dep-check",
33-
"release": "lerna run --concurrency 1 release -- --"
35+
"release": "npm run docs:no-publish && lerna run --concurrency 1 release && npm run docs"
3436
},
3537
"dependencies": {
38+
"aegir": "^37.7.8",
3639
"lerna": "^6.0.0",
3740
"rimraf": "^3.0.2"
3841
},

‎packages/interface-blockstore-tests/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# interface-blockstore-tests <!-- omit in toc -->
22

3-
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4-
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5-
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
3+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
4+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
65
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
7-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
87

98
> Compliance tests for the blockstore interface
109
@@ -13,6 +12,7 @@
1312
- [Install](#install)
1413
- [Usage](#usage)
1514
- [Contribute](#contribute)
15+
- [API Docs](#api-docs)
1616
- [License](#license)
1717
- [Contribute](#contribute-1)
1818

@@ -46,6 +46,10 @@ PRs accepted.
4646

4747
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
4848

49+
## API Docs
50+
51+
- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_blockstore_tests.html>
52+
4953
## License
5054

5155
Licensed under either of
@@ -55,8 +59,12 @@ Licensed under either of
5559

5660
## Contribute
5761

58-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
62+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
63+
64+
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
65+
66+
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
5967

60-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
68+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
6169

6270
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/interface-blockstore-tests/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,15 @@
150150
"release": "aegir release"
151151
},
152152
"dependencies": {
153-
"aegir": "^37.5.0",
153+
"aegir": "^37.7.8",
154154
"interface-blockstore": "^3.0.0",
155155
"it-all": "^1.0.2",
156156
"it-drain": "^1.0.1",
157157
"it-length": "^1.0.2",
158158
"multiformats": "^10.0.0",
159159
"uint8arrays": "^4.0.2"
160+
},
161+
"typedoc": {
162+
"entryPoint": "./src/index.js"
160163
}
161164
}

‎packages/interface-blockstore/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# interface-blockstore <!-- omit in toc -->
22

3-
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4-
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5-
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
3+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
4+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
65
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
7-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
87

98
> An interface for storing and retrieving blocks
109
1110
## Table of contents <!-- omit in toc -->
1211

1312
- [Install](#install)
1413
- [Contribute](#contribute)
14+
- [API Docs](#api-docs)
1515
- [License](#license)
1616
- [Contribute](#contribute-1)
1717

@@ -29,6 +29,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
2929

3030
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
3131

32+
## API Docs
33+
34+
- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_blockstore.html>
35+
3236
## License
3337

3438
Licensed under either of
@@ -38,8 +42,12 @@ Licensed under either of
3842

3943
## Contribute
4044

41-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
45+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
4246

43-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
47+
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
48+
49+
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
50+
51+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
4452

4553
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/interface-blockstore/package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"types": "./dist/src/index.d.ts",
2020
"files": [
2121
"src",
22-
"dist/src",
22+
"dist",
2323
"!dist/test",
2424
"!**/*.tsbuildinfo"
2525
],
@@ -131,6 +131,9 @@
131131
"multiformats": "^10.0.0"
132132
},
133133
"devDependencies": {
134-
"aegir": "^37.5.0"
134+
"aegir": "^37.7.8"
135+
},
136+
"typedoc": {
137+
"entryPoint": "./src/index.ts"
135138
}
136139
}

‎packages/interface-datastore-tests/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# interface-datastore-tests <!-- omit in toc -->
22

3-
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4-
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5-
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
3+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
4+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
65
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
7-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
87

98
> Compliance tests for the datastore interface
109
@@ -13,6 +12,7 @@
1312
- [Install](#install)
1413
- [Usage](#usage)
1514
- [Contribute](#contribute)
15+
- [API Docs](#api-docs)
1616
- [License](#license)
1717
- [Contribute](#contribute-1)
1818

@@ -46,6 +46,10 @@ PRs accepted.
4646

4747
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
4848

49+
## API Docs
50+
51+
- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_datastore_tests.html>
52+
4953
## License
5054

5155
Licensed under either of
@@ -55,8 +59,12 @@ Licensed under either of
5559

5660
## Contribute
5761

58-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
62+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
63+
64+
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
65+
66+
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
5967

60-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
68+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
6169

6270
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)