Building Documentation Pages for synapser

2025-07-25

The intended audience for this is developers and contributors to the synapser package who need to build or update the documentation pages after making changes to the package source code.

This document describes how to install the synapser client from local sources and rebuild documentation pages.

Installation Steps

1. Review Installation Instructions:
   • See installation.Rmd for details on installing synapser from local sources.
   • See systemDependencies.Rmd for required system dependencies.
2. Install synapser Locally:
   • Follow the steps in the above documents to complete the installation.

Rebuilding Documentation

After installation, open an R session in the project directory and run:

pkgdown::build_site()

This will regenerate all HTML documentation pages for the package.

Once all HTML documents are generated, commit your changes to a feature branch and follow the team’s normal process to get them merged.