commit | 280801e7ce66065a0950a6b7ec3ac99d0cb2dfe7 | [log] [tgz] |
---|---|---|
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | Sat Jun 01 19:26:59 2024 +0200 |
committer | GitHub <noreply@github.com> | Sat Jun 01 19:26:59 2024 +0200 |
tree | 0d885d92bb8ab177009823b5c138bb8307b80bbe | |
parent | b6cef65eb90a04e88faff7fb9c38dd94d6dee931 [diff] |
chore(python-docs): update python doc assets to recent development state (#177)
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(at most v18) and npm are required to build the documentation.
npm install
from the website-v2
directory by first running cd ./website-v2
.npm run start
to start the documentation for debugging purposes. The content will be served on http://localhost:3000
npm run build
to build the documentation This will create a folder website-v2/build
that includes all required static files.npm run ds-version NEW_VERSION
to release a new docs version.docs-python
to the website-v2/build
folder into a subdirectory named python
.The deployment step is done automatically using the asf.yaml process. Code must be merged into the master
branch in order to trigger an update of the website.