Add a script to core Polymer which can be used to run the initial documentation setup for Polymer and its extensions. Current practice is:
- Polymer and extension generated documentation via
mike Python package
mike deploys to gh-pages branch for pertinent repository
In order for the documentation deployment GitHub workflow to operate, an initial setup must be done on a local system (currently, though in the future this could perhaps be incorporated into the GitHub workflow).
To do initial setup for a Polymer extension:
polymer mk:docs to generate documentation
mike delete --all to clean up any existing content on gh-pages branch
mike deploy 0.x latest to generate documentation on the 0.x branch workspace
mike set-default latest to generate index.html with /latest url redirect
mike deploy -p 0.x to push the 0.x build (this must come after set-default because the index.html file won't be generated otherwise)
This should be scripted and documented as part of the documentation setup process for new and existing extensions without documentation setup already.
Add a script to core Polymer which can be used to run the initial documentation setup for Polymer and its extensions. Current practice is:
mikePython packagemikedeploys togh-pagesbranch for pertinent repositoryIn order for the documentation deployment GitHub workflow to operate, an initial setup must be done on a local system (currently, though in the future this could perhaps be incorporated into the GitHub workflow).
To do initial setup for a Polymer extension:
polymer mk:docsto generate documentationmike delete --allto clean up any existing content ongh-pagesbranchmike deploy 0.x latestto generate documentation on the 0.x branch workspacemike set-default latestto generate index.html with /latest url redirectmike deploy -p 0.xto push the 0.x build (this must come afterset-defaultbecause the index.html file won't be generated otherwise)This should be scripted and documented as part of the documentation setup process for new and existing extensions without documentation setup already.