1. Bio3D Project Avatar Bio3D Project
  2. Bio3D
  3. bio3d

Wiki

Clone wiki

bio3d / Generating the html statidocs documentation pages

View History

Steps to generate HTML documentation files for Bio3D

1. Download and install the modified Staticdocs package

#!r
git clone https://bitbucket.org/Grantlab/staticdocs.git
R CMD build staticdocs
R CMD INSTALL staticdocs_0.1.tar.gz

2. Then use the shell script to generate all files

#!r
cd bio3d/ver_devel/util

# To generate HTMLs with results of running all example codes in the RD files
./run_generate_html.sh

# To generate HTMLs without example results (update e.g. index.html)
./run_generate_html.sh no
Results will be present under html/.

3. Upload entire html folder to the web site http://thegrantlab.org/bio3d/

Updated