npm/ide-docs: move npm packaging to separate directory

This makes a clean separation between the packaging and the docs.
This commit is contained in:
David Lechner
2021-11-19 19:30:57 -06:00
parent fee122cf33
commit 9d8531a85b
7 changed files with 18 additions and 6 deletions
+5
View File
@@ -0,0 +1,5 @@
# build directory
html/
# yarn pack output
*.tgz
+2
View File
@@ -0,0 +1,2 @@
version-tag-prefix "@pybricks/ide-docs/v"
version-git-message "@pybricks/ide-docs v%s"
+8
View File
@@ -0,0 +1,8 @@
# Changelog
<!-- refer to https://keepachangelog.com/en/1.0.0/ for guidance -->
## Unreleased
### Changed
- Changed package directory structure.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018-2021 The Pybricks Authors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+6
View File
@@ -0,0 +1,6 @@
# @pybricks/ide-docs
This is a Node.js package for distributing the version of the Pybricks API
docs that is embedded in IDEs.
It contains all of the files needed to serve a static web site.
+23
View File
@@ -0,0 +1,23 @@
{
"name": "@pybricks/ide-docs",
"version": "1.6.0",
"description": "Special build of Pybricks API docs for embedding in an IDE.",
"repository": {
"type": "git",
"url": "https://github.com/pybricks/pybricks-api",
"directory": "npm/ide-docs"
},
"publishConfig": {
"registry": "https://registry.npmjs.org",
"access": "public"
},
"author": "The Pybricks Authors",
"license": "MIT",
"files": [
"html"
],
"scripts": {
"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"
}
}