Skip to content

Instantly share code, notes, and snippets.

@dch

dch/couchdocs.md

Created April 17, 2012 21:23
Show Gist options
  • Save dch/2409154 to your computer and use it in GitHub Desktop.
Save dch/2409154 to your computer and use it in GitHub Desktop.
Download ZIP
Setting up Couchbase API documentation generator
Raw
couchdocs.md

Pre-requisites

Use http://github.com/dch/couchdb-docs as source including modified perl scripts

perlbrew

curl -kL http://install.perlbrew.pl | bash
perlbrew install perl-5.14.2
perlbrew switch perl-5.14.2
perlbrew install-cpanm
cpanm Carp File::Basename IO:File Module::Load Module::Util XML::Parser::PerlSAX Image::Info Archive::Zip Cwd DateTime
cpanm --interactive --verbose File::Rsync

homebrew modules

brew install libxslt fop rename tree

Generation and Publishing to Apache.Org

clean out old docs

./DocKit/bin/clean.pl

generate new ones

make everything

move to my replication site

rename -ve 's/couchdb-manual/couchdb-manual-1.1.0/'

TODO

  • fix up links in single-file HTML version
  • figure out a better layout
  • add notes on adding a chapter
  • add notes on basic syntax for XMLy stuff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment