commit | f6adcb104dc4e69c6e6448c27525ecb4da7cbdfe | [log] [tgz] |
---|---|---|
author | bossenti <bossenti@posteo.de> | Mon Jun 19 17:57:09 2023 +0200 |
committer | bossenti <bossenti@posteo.de> | Mon Jun 19 17:57:09 2023 +0200 |
tree | c6da393ffe2d563a1c2fe0993167f14e6d7f2208 | |
parent | 3125be08208cfaa79a60d1465ba9e59a7d035ddc [diff] |
add python docs
This repository includes the website and documentation of Apache StreamPipes on https://streampipes.apache.org. Two different technologies are used to create both sites:
Both parts are merged to a single directory during the CI process.
Node.js and npm are required to build both sites.
npm install
from the root directory of this repository.npm run start-website
to start the website locally for debugging purposes. The content will be served on port 9000.npm run build-website
to build the website. This will create a folder build
that contains the generated static HTML and asset files.npm install
from the documentation/website
directory.npm run start
to start the documentation for debugging purposes. The content will be served on http://localhost:3000/docs
npm run build
to build the documentation This will create a folder build/streampipes-docs
that includes all required static files.npm run ds-version NEW_VERSION
to release a new docs version.streampipes-docs
) to the build
folder into a subdirectory named docs
.