Browse Source

Add a gendoc script

Dumps output to .godoc
kegan/readme-to-docs
Kegan Dougal 8 years ago
parent
commit
579cf29231
  1. 2
      .gitignore
  2. 20
      gendoc.sh

2
.gitignore

@ -1,3 +1,5 @@
.godoc
.*.swp .*.swp
# Compiled Object files, Static and Dynamic libs (Shared Objects) # Compiled Object files, Static and Dynamic libs (Shared Objects)

20
gendoc.sh

@ -0,0 +1,20 @@
#!/bin/bash
# Run a godoc server which we will scrape. Clobber the GOPATH to include
# only our dependencies.
GOPATH=$(pwd):$(pwd)/vendor godoc -http=localhost:6060 &
DOC_PID=$!
# Wait for the server to init
sleep 1
# Scrape the pkg directory for the API docs. Scrap lib for the CSS/JS. Ignore everything else.
# The output is dumped to the directory "localhost:6060".
wget -r -m -k -E -p --include-directories="/pkg,/lib" --exclude-directories="*" http://localhost:6060/pkg/github.com/matrix-org/go-neb/
# Stop the godoc server
kill -9 $DOC_PID
mv localhost\:6060 .godoc
echo "Docs can be found in .godoc"
echo "Replace /lib and /pkg in the gh-pages branch to update gh-pages"
Loading…
Cancel
Save