From 9d8531a85bf3f3a8ca115d48eb4a67792bca3c8e Mon Sep 17 00:00:00 2001 From: David Lechner Date: Fri, 19 Nov 2021 17:32:58 -0600 Subject: [PATCH] npm/ide-docs: move npm packaging to separate directory This makes a clean separation between the packaging and the docs. --- npm/ide-docs/.gitignore | 5 +++++ {doc/main => npm/ide-docs}/.yarnrc | 0 npm/ide-docs/CHANGELOG.md | 8 ++++++++ {doc/main => npm/ide-docs}/LICENSE | 0 {doc/main => npm/ide-docs}/README.md | 0 {doc/main => npm/ide-docs}/package.json | 9 ++++----- setup.cfg | 2 +- 7 files changed, 18 insertions(+), 6 deletions(-) create mode 100644 npm/ide-docs/.gitignore rename {doc/main => npm/ide-docs}/.yarnrc (100%) create mode 100644 npm/ide-docs/CHANGELOG.md rename {doc/main => npm/ide-docs}/LICENSE (100%) rename {doc/main => npm/ide-docs}/README.md (100%) rename {doc/main => npm/ide-docs}/package.json (67%) diff --git a/npm/ide-docs/.gitignore b/npm/ide-docs/.gitignore new file mode 100644 index 0000000..7597ce6 --- /dev/null +++ b/npm/ide-docs/.gitignore @@ -0,0 +1,5 @@ +# build directory +html/ + +# yarn pack output +*.tgz diff --git a/doc/main/.yarnrc b/npm/ide-docs/.yarnrc similarity index 100% rename from doc/main/.yarnrc rename to npm/ide-docs/.yarnrc diff --git a/npm/ide-docs/CHANGELOG.md b/npm/ide-docs/CHANGELOG.md new file mode 100644 index 0000000..d6ac1ff --- /dev/null +++ b/npm/ide-docs/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog + + + +## Unreleased + +### Changed +- Changed package directory structure. diff --git a/doc/main/LICENSE b/npm/ide-docs/LICENSE similarity index 100% rename from doc/main/LICENSE rename to npm/ide-docs/LICENSE diff --git a/doc/main/README.md b/npm/ide-docs/README.md similarity index 100% rename from doc/main/README.md rename to npm/ide-docs/README.md diff --git a/doc/main/package.json b/npm/ide-docs/package.json similarity index 67% rename from doc/main/package.json rename to npm/ide-docs/package.json index 2088cc6..ff1d6ef 100644 --- a/doc/main/package.json +++ b/npm/ide-docs/package.json @@ -5,7 +5,7 @@ "repository": { "type": "git", "url": "https://github.com/pybricks/pybricks-api", - "directory": "doc/main" + "directory": "npm/ide-docs" }, "publishConfig": { "registry": "https://registry.npmjs.org", @@ -14,11 +14,10 @@ "author": "The Pybricks Authors", "license": "MIT", "files": [ - "build/html/**" + "html" ], - "types": "index.d.ts", "scripts": { - "clean": "poetry run make -C .. clean", - "build": "poetry run make -C .. TAG=ide html" + "clean": "poetry run make -C ../../doc clean", + "build": "poetry run make -C ../../doc TAG=ide html && rm -rf html && cp -R ../../doc/main/build/html html" } } diff --git a/setup.cfg b/setup.cfg index 6ece41c..0259b3c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,5 +4,5 @@ exclude = .venv/,*.pyi max-line-length = 88 [doc8] -ignore-path = .venv/,doc/main/build/,pybricks.egg-info/ +ignore-path = .venv/,doc/main/build/,doc/api/build/,pybricks.egg-info/,npm/ max-line-length = 88