Skip to content

Commit 9d8531a

Browse files
committed
npm/ide-docs: move npm packaging to separate directory
This makes a clean separation between the packaging and the docs.
1 parent fee122c commit 9d8531a

File tree

7 files changed

+18
-6
lines changed

7 files changed

+18
-6
lines changed

npm/ide-docs/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# build directory
2+
html/
3+
4+
# yarn pack output
5+
*.tgz
File renamed without changes.

npm/ide-docs/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
<!-- refer to https://keepachangelog.com/en/1.0.0/ for guidance -->
4+
5+
## Unreleased
6+
7+
### Changed
8+
- Changed package directory structure.
File renamed without changes.
File renamed without changes.

doc/main/package.json renamed to npm/ide-docs/package.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/pybricks/pybricks-api",
8-
"directory": "doc/main"
8+
"directory": "npm/ide-docs"
99
},
1010
"publishConfig": {
1111
"registry": "https://registry.npmjs.org",
@@ -14,11 +14,10 @@
1414
"author": "The Pybricks Authors",
1515
"license": "MIT",
1616
"files": [
17-
"build/html/**"
17+
"html"
1818
],
19-
"types": "index.d.ts",
2019
"scripts": {
21-
"clean": "poetry run make -C .. clean",
22-
"build": "poetry run make -C .. TAG=ide html"
20+
"clean": "poetry run make -C ../../doc clean",
21+
"build": "poetry run make -C ../../doc TAG=ide html && rm -rf html && cp -R ../../doc/main/build/html html"
2322
}
2423
}

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ exclude = .venv/,*.pyi
44
max-line-length = 88
55

66
[doc8]
7-
ignore-path = .venv/,doc/main/build/,pybricks.egg-info/
7+
ignore-path = .venv/,doc/main/build/,doc/api/build/,pybricks.egg-info/,npm/
88
max-line-length = 88

0 commit comments

Comments
 (0)