# Building docs with Documenter.jl

**URL:** <https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159>\
**Category:** General Usage\
**Tags:** documentation, documenter, github-actions\
**Created:** [June 18, 2021, 8:32pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159 "2021-06-18T20:32:58Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![thazhemadam](https://avatars.discourse-cdn.com/v4/letter/t/ad7895/32.png) [@thazhemadam](https://discourse.julialang.org/u/thazhemadam)\
**Post date:** [June 18, 2021, 8:32pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/1 "2021-06-18T20:32:58Z")

</div>

I’ve been trying to get docs to build [here](https://github.com/Chemellia/ChemistryFeaturization.jl/tree/gh-pages), but for some reason only `dev` gets built after a new release gets tagged and registered ( even `stable` doesn’t get built). I thought adding the `versions` argument to the `deploydocs` function [here](https://github.com/Chemellia/ChemistryFeaturization.jl/blob/c5bde65a2dbb8f2bb992299b258bdac714785f83/docs/make.jl#L29) would fix, but it doesn’t look like it helped. This is the [CI workflow](https://github.com/Chemellia/ChemistryFeaturization.jl/blob/main/.github/workflows/Documentation.yml) that is supposed to build the docs. What am I missing here? I’d appreciate it if someone could help me get the docs to build properly.

---

<div class="post-metadata">

**Author:** ![lmiq](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/lmiq/32/18314_2.png) [@lmiq](https://discourse.julialang.org/u/lmiq)\
**Post date:** [June 18, 2021, 9:13pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/2 "2021-06-18T21:13:22Z")

</div>

I follow these steps: [Publish Docs · JuliaNotes.jl](https://m3g.github.io/JuliaNotes.jl/stable/publish_docs/)

---

<div class="post-metadata">

**Author:** ![mortenpi](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mortenpi/32/158_2.png) [@mortenpi](https://discourse.julialang.org/u/mortenpi)\
**Post date:** [June 18, 2021, 11:52pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/3 "2021-06-18T23:52:12Z")

</div>

It looks like your TagBot is not picking up the `ssh` token (`DOCUMENTER_KEY`). Compare [your TagBot run](https://github.com/Chemellia/ChemistryFeaturization.jl/runs/2859422397?check_suite_focus=true#step:3:3) vs [Documenter’s own TagBot run](https://github.com/JuliaDocs/Documenter.jl/runs/2854652911?check_suite_focus=true#step:3:4). I don’t know why it didn’t pick it up, but the `ssh` token is [necessary to trigger CI runs on tags](https://github.com/JuliaRegistries/TagBot#ssh-deploy-keys), which then would deploy the `stable/` docs.

---

<div class="post-metadata">

**Author:** ![MattWillFlood](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mattwillflood/32/20722_2.png) [@MattWillFlood](https://discourse.julialang.org/u/MattWillFlood)\
**Post date:** [March 26, 2024, 6:33pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/4 "2024-03-26T18:33:14Z")

</div>

The same issue is happening when I try to publish docs for [EntropyHub.jl](https://github.com/MattWillFlood/EntropyHub.jl)… 🤔

I hadn’t updated the docs in a couple years and now that I do, all sorts of errors are cropping up 🥲

When it comes to CI and github actions, my knowledge base is **very limited** 🐒, but I’ve noticed a couple of things that **_might_** be causing the same `dev` foder / TagBot issue (??? 🤷‍♂️)

1. Inside the `dev` folder, there is a file called [`siteinfo.js`](https://github.com/MattWillFlood/EntropyHub.jl/blob/gh-pages/dev/siteinfo.js) created around the last time I updated the docs. Inside it has a single line which reads:  
`var DOCUMENTER_CURRENT_VERSION = "dev";`  
Could removing this stop the files building in `dev`?

2. When I go to the Travi-CI page for this repo, it says:

> Builds have been temporarily disabled for public repositories due to a negative credit balance. Please go to the [Plan page](https://app.travis-ci.com/account/plan) to replenish your credit balance or alter your [Consume paid credits for OSS setting](https://app.travis-ci.com/account/plan?anchor=oss-consumption).

- I was using the free plan and used up all the build credits trying to get the docs to build correctly years ago. Could it be that without credits, this `dev` folder issue is related to a negaitve Travis-CI credit balance??

If any of the more expert Julians here can offer their opinion, it would be greatly appreciated! 🙏 🙏 🙏

---

<div class="post-metadata">

**Author:** ![goerz](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/goerz/32/3269_2.png) [@goerz](https://discourse.julialang.org/u/goerz)\
**Post date:** [March 26, 2024, 9:12pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/5 "2024-03-26T21:12:31Z")

</div>

> [@MattWillFlood](#):
>
> Could it be that without credits, this `dev` folder issue is related to a negaitve Travis-CI credit balance

Yeah, Travis is dead (as the go-to CI solution for open source that it was 5 or so years ago). You’re going to have to switch to GitHub Actions.

---

<div class="post-metadata">

**Author:** ![MattWillFlood](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mattwillflood/32/20722_2.png) [@MattWillFlood](https://discourse.julialang.org/u/MattWillFlood)\
**Post date:** [March 27, 2024, 6:16pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/6 "2024-03-27T18:16:07Z")

</div>

Coolio, thanks @goerz👍

By switching to GitHub actions, would that in any way prevent JuliaHub from linking to the docs website associated with the package?

---

<div class="post-metadata">

**Author:** ![goerz](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/goerz/32/3269_2.png) [@goerz](https://discourse.julialang.org/u/goerz)\
**Post date:** [March 27, 2024, 6:27pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/7 "2024-03-27T18:27:27Z")

</div>

No, those things are completely unrelated.

JuliaHub will always link to their own built of your documentation, or you can opt out and have it link to _your_ built of the documentation instead by submitting a pull request to [GitHub - JuliaDocs/DocumentationGeneratorRegistry](https://github.com/JuliaDocs/DocumentationGeneratorRegistry/tree/master)

See [Documentation rendered fine in GitHub but not on juliahub - #2 by mbauman](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/2)

---

<div class="post-metadata">

**Author:** ![MattWillFlood](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mattwillflood/32/20722_2.png) [@MattWillFlood](https://discourse.julialang.org/u/MattWillFlood)\
**Post date:** [March 27, 2024, 7:12pm UTC](https://discourse.julialang.org/t/building-docs-with-documenter-jl/63159/8 "2024-03-27T19:12:44Z")

</div>

Thanksa mil for your help 🙏