<commit_before>Realm Documentation
===================

You probably want to go and [read the docs on the Realm project website](http://realm.io/docs/ios)

Most of the documentation for the project is contained inline as comments in our header files. The `docs/source/` folder contains additional long-form articles such as our docs index page.

You can generate the docs locally by using the build.sh script at the root of this repository

```
sh build.sh docs
```

This will generate HTML docs under `docs/html/` and Appledocset packages for Xcode and Dash under `docs/docset`.<commit_msg>Added links to docset tools and appledoc dependency.<commit_after>Realm Documentation
===================

You probably want to go and [read the docs on the Realm project website](http://realm.io/docs/ios)

Most of the documentation for the project is contained inline as comments in our header files. The `docs/source/` folder contains additional long-form articles such as our docs index page.

You can generate the docs locally by using the build.sh script at the root of this repository. This requires installation of [appledoc](https://github.com/tomaz/appledoc/releases/tag/v2.2-963).

```
sh build.sh docs
```

This will generate HTML docs under `docs/html/` and Apple docset packages under `docs/docset`. You can view the docset locally with tools like [Dash](http://kapeli.com/dash) or in Xcode directly with e.g. [Docs for XCode](http://georiot.co/docsforxcode).

{'fraction_non_alphanumeric': 0.10177595628415301, 'fraction_numerical': 0.0034153005464480873, 'mean_word_length': 4.591603053435114, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4351388', 'n_tokens_mistral': 410, 'n_tokens_neox': 388, 'n_words': 189}