# Building documentation for module

**URL:** <https://discourse.julialang.org/t/building-documentation-for-module/44460>\
**Category:** General Usage\
**Created:** [August 6, 2020, 10:39pm UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460 "2020-08-06T22:39:28Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![danielw2904](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/danielw2904/32/10890_2.png) [@danielw2904](https://discourse.julialang.org/u/danielw2904)\
**Post date:** [August 6, 2020, 10:39pm UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/1 "2020-08-06T22:39:28Z")

</div>

I have implemented a [small module](https://github.com/danielw2904/JSONL.jl) to read [JSONLines](https://clickhouse.tech/docs/en/interfaces/formats/#jsoneachrow) files and especially parts of a file without loading the whole file into memory. I would (eventually) like to register the package so I would like to build documentation from the docstrings but I cannot get it working using Documenter.jl and I think I am fundamentally misunderstanding something. Could someone point me in the right direction of how to build the docs?

Thanks!

---

<div class="post-metadata">

**Author:** ![anon37204545](https://avatars.discourse-cdn.com/v4/letter/a/439d5e/32.png) [@anon37204545](https://discourse.julialang.org/u/anon37204545)\
**Post date:** [August 6, 2020, 10:58pm UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/2 "2020-08-06T22:58:04Z")

</div>

What’s the error you are getting? Is it a problem with building docs locally, or deploying them?

Instead of manually setting up `make.jl` for docs (and other config files), you can use [PkgTemplates.jl](https://github.com/invenia/PkgTemplates.jl) to do it for you.

---

<div class="post-metadata">

**Author:** ![danielw2904](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/danielw2904/32/10890_2.png) [@danielw2904](https://discourse.julialang.org/u/danielw2904)\
**Post date:** [August 6, 2020, 11:12pm UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/3 "2020-08-06T23:12:58Z")

</div>

Thank you! I’ll try that.  
I was trying to build them locally and the error was about deployment. So I guess I need to build the package through github?

---

<div class="post-metadata">

**Author:** ![anon37204545](https://avatars.discourse-cdn.com/v4/letter/a/439d5e/32.png) [@anon37204545](https://discourse.julialang.org/u/anon37204545)\
**Post date:** [August 6, 2020, 11:15pm UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/4 "2020-08-06T23:15:18Z")

</div>

> [@danielw2904](#):
>
> I was trying to build them locally and the error was about deployment. So I guess I need to build the package through github?

It’d help if you posted that error message. I think the error is unrelated to deployment, as when you build the docs locally, the deployment is ignored.

---

<div class="post-metadata">

**Author:** ![danielw2904](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/danielw2904/32/10890_2.png) [@danielw2904](https://discourse.julialang.org/u/danielw2904)\
**Post date:** [August 7, 2020, 8:01am UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/5 "2020-08-07T08:01:13Z")

</div>

I am getting the following which now looks like it is expected since I am building locally:

```julia
 ~/Documents/juliaPkgs/JSONL.jl/docs (master u=)> julia --project="." make.jl
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: Documenter could not auto-detect the building environment Skipping deployment.
└ @ Documenter ~/.julia/packages/Documenter/PLD7m/src/deployconfig.jl:41

```

I do not get any html files or so with my docs in it. Is that correct?

---

<div class="post-metadata">

**Author:** ![danielw2904](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/danielw2904/32/10890_2.png) [@danielw2904](https://discourse.julialang.org/u/danielw2904)\
**Post date:** [August 7, 2020, 8:41am UTC](https://discourse.julialang.org/t/building-documentation-for-module/44460/6 "2020-08-07T08:41:34Z")

</div>

I used PkgTemplates.jl and got it working ([Home · JSONL.jl](https://danielw2904.github.io/JSONL.jl/dev/)). Thank you very much for your help!