Welcome to cookiecutter-rscripts documentation!

• Source code on GitLab

This project aims at providing users of the R statistical language a template to produce documentation with the python Sphinx package.

Getting Started

• Tutorial
  • Step 1: Setup a virtual environment
  • Step 2: Install cookiecutter
  • Step 3: Generate your project
  • Step 3: Build your rproject project locally
  • Step 4: Write your doc
  • Step 5: Create a GitLab Repo
  • Step 6: Activate your GitLab repo
  • Step 8: Build and publish your doc on Read the docs
• Troubleshooting
  • Windows Issues
• Contributing
  • Report issues

Basics

• Prompts
  • Templated Values
  • Options

Advanced Features

• Console Script Setup
  • How It Works
  • Usage
  • Known Issues
  • More Details
• What does this cookie taste like?
  • Documentation

Indices and tables

• Index
• Module Index
• Search Page