commit | a59c769ffc4b9e5fe90b0b5c8f0aa4b4651cec33 | [log] [tgz] |
---|---|---|
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | Sat Oct 14 11:20:12 2023 +0200 |
committer | GitHub <noreply@github.com> | Sat Oct 14 11:20:12 2023 +0200 |
tree | cd2af664d35cb88a39b94538ba30dbb40b9ef105 | |
parent | 16e1dc50815b4449ddf546a7fbb2d87d3bd411aa [diff] |
chore(python-docs): update python doc assets to recent development state (#120)
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.