Template use - cma-open/cmatools GitHub Wiki

The cmatools and cmascience repos can both be used to create new project repos by clicking the "Use this template" button

This allows:

• easy creation of a new project repos containing these files, directory structure and documentation
• simple editing of the template content can then kick start new development
• presence of existing setup.py files and tests may ease initial development

Once a new repo has been created there are several additional steps required, including:

• Create additionl GitHub branches
• Find and replace repo project name
• Wiki setup and content

---

Steps to rebuild the project and repo (replicability)

Enabling use of github pages to host documentation

Assuming the project has already been checked out locally

git checkout --orphan gh-pages

Commit the changes to create the empty branch

git commit --allow-empty -m "root commit"
git push origin gh-pages
mkdir -p docs/build
touch .nojekyll
touch docs/build/.nojekyll
git add .nojekyll
git add docs/build/.nojekyll
git commit -m "added .nojekyll"

Add a redirect index at root to point to the docs/build subdir Replace the name of the repo

Add a deploy key https://github.com/settings/tokens and create new secrect DEPLOY_TOKEN, copy above token value into new secret