Kitware/paraview-docs

Name: paraview-docs

Owner: Kitware, Inc.

Description: ParaView documentation

Created: 2017-08-05 14:52:35.0

Updated: 2017-09-28 22:58:44.0

Pushed: 2017-09-29 17:31:25.0

Homepage: https://kitware.github.io/paraview-docs/

Size: 148323

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Paraview-doc

Automated publication of ParaView documentation via github pages.

selector.js

This script injects a version selector into the C++ and Python documentation. It selects a header element of the docs and appends a <select> element with a version list as well as a link to the other language documentation.

To build with webpack:

• npm install
• npm run build:release

The resulting script is dist/paraview-version.js.

Shell script to automate publication

ripts/prepare-doc.sh /path/to/paraview/src /path/to/paraview/build /path/to/workdir

For nightly you may want to use/edit the given script to force the name of the version to be nighlty instead of the result of git describe.

How to update the generated script

You will need to copy and commit dist/paraview-version.js from master to the root of gh-pages directory.