commit | 2b1624198a3a9293dc9e69434101ea1a25397e36 | [log] [tgz] |
---|---|---|
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | Sun Nov 12 09:52:40 2023 +0100 |
committer | GitHub <noreply@github.com> | Sun Nov 12 09:52:40 2023 +0100 |
tree | 9806f73df6f52c57fdc8fcfd61564f226f46eaaf | |
parent | df360126b49dce9c4cbf76150fbdc75da4ff2766 [diff] |
chore(python-docs): update python doc assets to recent development state (#133)
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.