commit | efc05fa6406416442c59719cd56d228764d78484 | [log] [tgz] |
---|---|---|
author | Tim <50115603+bossenti@users.noreply.github.com> | Fri Mar 10 20:46:32 2023 +0100 |
committer | GitHub <noreply@github.com> | Fri Mar 10 20:46:32 2023 +0100 |
tree | a767a8a08b605a6fbb8eadf5f6d7aa9ab6e847d8 | |
parent | 9e314d09bd8a0082bc1392d5eead684cbc2b5632 [diff] |
feature(docs): creating landing page for python docs and add build python docs (#62) * add python docs as landing page * chore(gh-actions): update python docs * chore(docs): add python docs as versioned docs * Move python docs to root directory --------- Co-authored-by: Dominik Riemer <dominik.riemer@gmail.com>
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
.