srcco

README

  ____      _ __       ___        ___        ___   
 /',__\    /\`'__\    /'___\     /'___\     / __`\ 
/\__, `\   \ \ \/    /\ \__/    /\ \__/    /\ \_\ \
\/\____/    \ \_\    \ \____\   \ \____\   \ \____/
 \/___/      \/_/     \/____/    \/____/    \/___/ 
                                                       

srcco (pronounced "source-co") is a literate-programming-style
documentation generator that makes the code clickable so you can jump
to the definition of any function, type, or variable.

For more information, see:
  http://sourcegraph.github.io/srcco/srcco.go.html

Built on top of srclib (https://srclib.org).
Inspired by Docco (http://jashkenas.github.io/docco/), Groc
(http://nevir.github.io/groc/), and Gocco
(http://nikhilm.github.io/gocco/).

Installation:

  $ go get sourcegraph.com/sourcegraph/srcco

And install srclib:

  $ go get sourcegraph.com/sourcegraph/srclib/cmd/src
  # This will only pull down the Go toolchain.
  $ src toolchain install-std --skip-ruby --skip-javascript --skip-python

Then call srcco like this in the directory you want to build: 

  $ srcco .

Usage: srcco [FLAGS] DIR

  Generate documentation for the project at DIR.
  For more information, see:
          sourcegraph.github.io/srcco
    -github-pages=false: create docs in gh-pages branch
    -out="docs": The directory name for the output files
    -v=false: show verbose output

Languages currently supported:

- Go

Languages that will be supported soon:

- Python
- Ruby
- JavaScript
- Java

Documentation

Overview

srcco (pronounced "source-co") is a literate-programming-style documentation generator that links up source code so you can jump to the definition of any function, type, or variable.

Built on top of srclib (https://srclib.org).

Inspired by Docco (http://jashkenas.github.io/docco/), Groc (http://nevir.github.io/groc/), and Gocco (http://nikhilm.github.io/gocco/).

Installation:

$ go get sourcegraph.com/sourcegraph/srcco

And install srclib:

$ go get sourcegraph.com/sourcegraph/srclib/cmd/src
# This will only pull down the Go toolchain.
$ src toolchain install-std --skip-ruby --skip-javascript --skip-python

Then call srcco like this in the directory you want to build:

$ srcco .

If you want to host your docs on GitHub Pages, run:

$ srcco -github-pages=true .

Usage: srcco [FLAGS] DIR

Generate documentation for the project at DIR.

  -enable-sourcegraph=false: generate links to Sourcegraph.com for references to external (out of repo) definitions
  -github-pages=false: create docs in gh-pages branch
  -out="docs": the directory name for the output files
  -v=false: show verbose output

I extended the Go srclib toolchain (https://sourcegraph.com/sourcegraph/srclib-go) to add start and end ranges to comments. None of the other toolchains output this information currently, but it shouldn't be that hard to add.

Languages that will be supported soon: (if you're interested in hacking on a srclib toolchain, get in touch with the author of srcco and I can help you get spun up)

- Python

- Ruby

- JavaScript

- Java

Patches welcome!