JGCRI / hector

The Hector Simple Climate Model
http://jgcri.github.io/hector/
GNU General Public License v3.0
113 stars 47 forks source link

Build V3 Documentation #616

Closed kdorheim closed 1 year ago

kdorheim commented 2 years ago

Building pkgown documentation

  1. Check out v3_dev branch, disconnect from VPN
  2. Clean rebuild of the Hector package
  3. Quit out of chrome or whatever app is used to preview HTML files. (This is not always necessary but after a certain amount of time you may be prompted to give chrome access viewing local HTML files, quitting out of the chrome is the only way to prompt this if it is actually needed) from R console rung pkgdown::build_site() this will build it locally. There are other options such as build_home(), build_reference(), and build_articles() to specify which option you would like to update which can save time. Note the search bar will not appear at the moment because we are building it locally it only appears on remote builds.
kdorheim commented 1 year ago

can be closed when #671 is merged