Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 2.35 KB

README.md

File metadata and controls

87 lines (56 loc) · 2.35 KB
Raw

pypose.org site

https://pypose.org

A static website built in Jekyll and Bootstrap for PyPose, and its tutorials and documentation.

Prerequisites

Install the following packages before attempting to setup the project:

On OSX, you can use:

brew install rbenv ruby-build nvm

Setup

Install required Ruby version:

#### You only need to run these commands if you are missing the needed Ruby version.

rbenv install `cat .ruby-version`
gem install bundler -v 1.16.3
rbenv rehash

####

bundle install
rbenv rehash

Install required Node version

nvm install
nvm use

Install Yarn

brew install yarn --ignore-dependencies
yarn install

Local Development

To run the website locally for development:

make serve

Then navigate to localhost:4000.

Note the serve task is contained in a Makefile in the root directory. We are using make as an alternative to the standard jekyll serve as we want to run yarn, which is not included in Jekyll by default.

Building the Static Site

To build the static website from source:

make build

This will build the static site at ./_site. This directory is not tracked in git.

Deployments

The website is hosted on Github Pages at https://pypose.org.

To deploy changes, merge your latest code into the site branch. A build will be automatically built and committed to the gh-pages branch via a CircleCI job.

To view the status of the build visit https://github.com/pypose/pypose.github.io/actions.

Contributing to PyPose Documentation and Tutorials

  • You can find information about contributing to PyPose documentation in the PyPose repo README.md file.
  • Information about contributing to PyPose Tutorials can be found in the tutorials README.md.
  • Additional contribution information can be found in PyPose CONTRIBUTING.md.