<commit_before># Lapidary

A documentation generator for Julia.

[![Build Status](https://travis-ci.org/MichaelHatherly/Lapidary.jl.svg?branch=master)](https://travis-ci.org/MichaelHatherly/Lapidary.jl)
[![codecov.io](http://codecov.io/github/MichaelHatherly/Lapidary.jl/coverage.svg?branch=master)](http://codecov.io/github/MichaelHatherly/Lapidary.jl?branch=master)

## Brief Overview

**Doctests**

Any code block with `.language` set to `"julia"` containing either REPL prompts, `julia>`, or
an `# output:` comment. For example:

~~~
```julia
julia> a = 1
1

julia> b = 2;

julia> a + b
3
```
~~~

or

~~~
```julia
a = 1
b = 2
a + b

# output:

3
```
~~~

Errors can be checked for using the `{throws ErrorName}` syntax, i.e.

~~~
```julia
julia> div(1, 0)

    {throws DivideError}

```
~~~

**Docstring Splicing**

Docstrings for objects documented using Julia's docsystem can be spliced into the markdown
files using code blocks containing `{docs}` as their first line:

    ```
    {docs}
    foo
    bar
    baz
    ```

Operators must be enclosed, i.e. `(+)`.

**Metadata**

Metadata, such as the current module, can be set for a page using the `{meta}` code block:

    ```
    {meta}
    CurrentModule = Base
    ```

Changing the module allows one to avoid having to fully qualify every object spliced into a<commit_msg>Fixup README rendering.<commit_after># Lapidary

A documentation generator for Julia.

[![Build Status](https://travis-ci.org/MichaelHatherly/Lapidary.jl.svg?branch=master)](https://travis-ci.org/MichaelHatherly/Lapidary.jl)
[![codecov.io](http://codecov.io/github/MichaelHatherly/Lapidary.jl/coverage.svg?branch=master)](http://codecov.io/github/MichaelHatherly/Lapidary.jl?branch=master)

## Brief Overview

**Doctests**

Any code block with `.language` set to `"julia"` containing either REPL prompts, `julia>`, or
an `# output:` comment. For example:

```
    ```julia
    julia> a = 1
    1

    julia> b = 2;

    julia> a + b
    3
    ```
```

or

```
    ```julia
    a = 1
    b = 2
    a + b

    # output:

    3
    ```
```

Errors can be checked for using the `{throws ErrorName}` syntax, i.e.

```
    ```julia
    julia> div(1, 0)

        {throws DivideError}

    ```
```

**Docstring Splicing**

Docstrings for objects documented using Julia's docsystem can be spliced into the markdown
files using code blocks containing `{docs}` as their first line:

    ```
    {docs}
    foo
    bar
    baz
    ```

Operators must be enclosed, i.e. `(+)`.

**Metadata**

Metadata, such as the current module, can be set for a page using the `{meta}` code block:

    ```
    {meta}
    CurrentModule = Base
    ```

Changing the module allows one to avoid having to fully qualify every object spliced into a
{'fraction_non_alphanumeric': 0.14374090247452692, 'fraction_numerical': 0.006550218340611353, 'mean_word_length': 3.419614147909968, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 4, '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': '7601117', 'n_tokens_mistral': 1030, 'n_tokens_neox': 956, 'n_words': 285}