Juce docs on Github

General JUCE discussion
1

Jules, if you want the documentation to be readable in HTML then you should put the contents of the html folder into its own branch called gh-pages. For example:

http://vinniefalco.github.com/VFLib/

Yours would be at http://julianstorer.github.com/JUCE-API-Documentation

In general, you can put any HTML (including images, subdirectories, client side java scripts, style sheets, etc) into its own branch called gh-pages in the Github repo, and it will be published to this URL http://{account}.github.com/{repo}

This page explains how to make the empty branch http://help.github.com/pages/ here are the commnds:

$ cd /path/to/fancypants
$ git symbolic-ref HEAD refs/heads/gh-pages
$ rm .git/index
$ git clean -fdx

Note that executing this code will lose any uncomitted changes

2

Yeah, I’m happy enough with the HTML being viewed here on my website. The github mirror is just there so that people who want a local copy can pull it from there.

3

Oh! So http://www.rawmaterialsoftware.com/juce/api/index.html is official and kept up to date?

4

Yes, that’ll be automatically kept up-to-date with the latest version now.

5

Great! Can you please set GENERATE_TAGFILE in juce_api_config

GENERATE_TAGFILE       = juce.tag

This will output a tag file next time you create the docs

6

Yep, will do.

7

Please let me know when it’s there (and the URL) so I can play!

8

Done already!

9

Hmm…I’m not finding the file. I’m looking here:

http://www.rawmaterialsoftware.com/juce/api/juce.tag

10

Gah… It’s in the wrong folder. Fixed now.

11

Okay I picked up the tag file and referenced it in my Doxygen configuration file, this is REALLY COOL!!!

Every time I mention a juce class or member function in my own docs, it is automatically hyperlinked to the right place in the official Juce documentation at http://www.rawmaterialsoftware.com/juce/api/ !!!

So I can talk about CriticalSection, AudioSampleBuffer, AudioDeviceIOCallback, et. al. and have clickable links!!!