diff --git a/doc/ide/.yarnrc b/doc/ide/.yarnrc new file mode 100644 index 0000000..56a249f --- /dev/null +++ b/doc/ide/.yarnrc @@ -0,0 +1,2 @@ +version-tag-prefix "@pybricks/ide-docs/v" +version-git-message "@pybricks/ide-docs v%s" diff --git a/doc/ide/CHANGELOG.md b/doc/ide/CHANGELOG.md new file mode 100644 index 0000000..c3fcf2a --- /dev/null +++ b/doc/ide/CHANGELOG.md @@ -0,0 +1,5 @@ + +# 1.0.0 - 2021-01-25 + +## Added: +- Sphinx build output. diff --git a/doc/ide/LICENSE b/doc/ide/LICENSE new file mode 100644 index 0000000..b483190 --- /dev/null +++ b/doc/ide/LICENSE @@ -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. diff --git a/doc/ide/README.md b/doc/ide/README.md new file mode 100644 index 0000000..74fbd67 --- /dev/null +++ b/doc/ide/README.md @@ -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. diff --git a/doc/ide/package.json b/doc/ide/package.json new file mode 100644 index 0000000..48c052b --- /dev/null +++ b/doc/ide/package.json @@ -0,0 +1,24 @@ +{ + "name": "@pybricks/ide-docs", + "version": "1.0.0", + "description": "Special build of Pybricks API docs for embedding in an IDE.", + "repository": { + "type": "git", + "url": "https://github.com/pybricks/pybricks-api", + "directory": "doc/ide" + }, + "publishConfig": { + "registry": "https://registry.npmjs.org", + "access": "public" + }, + "author": "The Pybricks Authors", + "license": "MIT", + "files": [ + "build/html/**" + ], + "types": "index.d.ts", + "scripts": { + "clean": "poetry run make -C .. SOURCEDIR=ide clean", + "build": "poetry run make -C .. SOURCEDIR=ide html" + } +}