# Help with package documentation

**URL:** <https://discourse.julialang.org/t/help-with-package-documentation/54423>\
**Category:** General Usage\
**Tags:** package, documentation, documenter, github-actions\
**Created:** [February 1, 2021, 11:33pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423 "2021-02-01T23:33:49Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![apoor](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/apoor/32/21367_2.png) [@apoor](https://discourse.julialang.org/u/apoor)\
**Post date:** [February 1, 2021, 11:33pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/1 "2021-02-01T23:33:49Z")

</div>

I’m working on developing my first Julia package called `FeatureEng` – for feature engineering – and I’m having trouble working with `Documenter.jl`.

[https://github.com/a-poor/FeatureEng.jl](https://github.com/a-poor/FeatureEng.jl)

I have a [github workflow](https://github.com/a-poor/FeatureEng.jl/blob/93fc3273b7895baf78f2fb4553a7b77f9f1b2c8a/.github/workflows/build.yml#L22) that builds  
the documentation with the following commands:

```nohighlight
julia --project=docs -e '
            using Pkg
            Pkg.develop(PackageSpec(path=pwd()))
            Pkg.instantiate()'
julia --project=docs docs/make.jl

```

and the following in my `docs/src/index.md` file:

````markdown
```@autodoc
Modules = [FeatureEng]
```

````

but nothing is showing up and I’m getting the following warning message, saying that my docstrings aren’t being included in my docs:

```nohighlight
[ Info: CheckDocument: running document checks.
┌ Warning: 13 docstrings not included in the manual:
│ 
│ FeatureEng.transformLog :: Union{Tuple{T}, Tuple{T,Real}} where T<:(AbstractArray{var"#s19",N} where N where var"#s19"<:Number)
│ FeatureEng.transformRoot :: Union{Tuple{T}, Tuple{T,Real}} where T<:(AbstractArray{var"#s19",N} where N where var"#s19"<:Number)
│ FeatureEng.encode_dummy :: Union{Tuple{T}, Tuple{T,T,String}} where T<:AbstractArray
│ FeatureEng.encode_hash :: Union{Tuple{T}, Tuple{T,Int32}, Tuple{T,Int32,String}} where T<:AbstractArray
│ FeatureEng.transformBoxCox :: Union{Tuple{T}, Tuple{T,Real}} where T<:(AbstractArray{var"#s19",N} where N where var"#s19"<:Number)
│ FeatureEng.strp_datetimes :: Union{Tuple{T}, Tuple{T,Union{String, Dates.DateFormat}}} where T<:(AbstractArray{var"#s19",N} where N where var"#s19"<:AbstractString)
│ FeatureEng.extract_time_features :: Tuple{T} where T<:(AbstractArray{var"#s20",N} where N where var"#s20"<:Union{Dates.DateTime, Dates.Time})
│ FeatureEng.get_month :: Tuple{T} where T<:(AbstractArray{var"#s20",N} where N where var"#s20"<:Union{Dates.Date, Dates.DateTime})
│ FeatureEng.encode_onehot :: Union{Tuple{T}, Tuple{T,T,String}} where T<:AbstractArray
│ FeatureEng.extract_datetime_features :: Tuple{T} where T<:(AbstractArray{var"#s20",N} where N where var"#s20"<:Dates.DateTime)
│ FeatureEng.extract_date_features :: Tuple{T} where T<:(AbstractArray{var"#s20",N} where N where var"#s20"<:Union{Dates.Date, Dates.DateTime})
│ FeatureEng.polynomial :: Union{Tuple{DataFrames.DataFrame}, Tuple{T}, Tuple{DataFrames.DataFrame,T}} where T<:Integer
│ FeatureEng.get_weekday :: Tuple{T} where T<:(AbstractArray{var"#s20",N} where N where var"#s20"<:Union{Dates.Date, Dates.DateTime})
│ 
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/FuXcO/src/DocChecks.jl:69

```

Additionally, `Documenter.jl` isn’t creating versions other than `dev` in my [`gh-pages` branch](https://github.com/a-poor/FeatureEng.jl/tree/gh-pages).

I’ve tried looking through [`Documenter.jl`’s docs](https://juliadocs.github.io/Documenter.jl/stable/), the [julialang Documentation page](https://docs.julialang.org/en/v1/manual/documentation/), and comparing my repo with [Example.jl](https://github.com/JuliaLang/Example.jl) for reference.

Here’s the link to my documentation:

[https://a-poor.github.io/FeatureEng.jl/dev/api-reference/](https://a-poor.github.io/FeatureEng.jl/dev/api-reference/)

What am I doing wrong? Any suggestions would be greatly appretiated.

Thanks in advance! 😀

---

<div class="post-metadata">

**Author:** ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Post date:** [February 2, 2021, 12:54am UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/2 "2021-02-02T00:54:51Z")

</div>

> [@apoor](#):
>
> and the following in my `docs/src/index.md` file:

`@autodoc` → `@autodocs`

> [@apoor](#):
>
> Additionally, `Documenter.jl` isn’t creating versions other than `dev` in my [`gh-pages` branch](https://github.com/a-poor/FeatureEng.jl/tree/gh-pages).

The CI workflow is not triggered by tagbot unless you pass it an SSH key, cf. [GitHub - JuliaRegistries/TagBot: Creates tags, releases, and changelogs for your Julia packages when they're registered](https://github.com/JuliaRegistries/TagBot#setup) and the yellow box here: [Hosting Documentation · Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#GitHub-Actions)

---

<div class="post-metadata">

**Author:** ![apoor](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/apoor/32/21367_2.png) [@apoor](https://discourse.julialang.org/u/apoor)\
**Post date:** [February 2, 2021, 5:25pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/3 "2021-02-02T17:25:23Z")

</div>

Thank you, @fredrikekre! I can’t believe I missed that typo. One follow-up question:

I only have one release on github, `v1.0.1` and TagBot says

```julia
Tag v1.0.1 already exists

```

but I’ve changed the package version in the Project.toml, via git tags, and as an input to the Register Action on GitHub.

Is there something else I’m missing?

Thanks for all your help!

---

<div class="post-metadata">

**Author:** ![mmiller](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mmiller/32/20805_2.png) [@mmiller](https://discourse.julialang.org/u/mmiller)\
**Post date:** [February 2, 2021, 10:13pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/4 "2021-02-02T22:13:02Z")

</div>

TagBot isn’t updating the version because the [latest registered version](https://github.com/JuliaRegistries/General/tree/master/F/FeatureEng) is `v1.0.1`

I’m not sure about the `register.yml`, but I find the best way to register a package is with [`Registrator.jl`](https://github.com/JuliaRegistries/Registrator.jl/blob/master/README.md). Once installed you can just comment on the commit you want to register, which will create the pull request to the registry. Once this is merged, TagBot will tag the version the next time it runs.

EDIT: Maybe Registrator is not installed?  
I see you tried to register this version but it didn’t reply in the comments: [https://github.com/a-poor/FeatureEng.jl/commit/a35f1552cf22494ff080673870f267d9a06fd228](https://github.com/a-poor/FeatureEng.jl/commit/a35f1552cf22494ff080673870f267d9a06fd228)

EDIT 2: I see the register.yml is for the [register action](https://github.com/julia-actions/RegisterAction), cool I didn’t know this was a thing!

---

<div class="post-metadata">

**Author:** ![apoor](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/apoor/32/21367_2.png) [@apoor](https://discourse.julialang.org/u/apoor)\
**Post date:** [February 2, 2021, 10:24pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/5 "2021-02-02T22:24:53Z")

</div>

After commenting on the commit, how can I tell if the pull request to the registry has started?

[https://github.com/a-poor/FeatureEng.jl/commit/a35f1552cf22494ff080673870f267d9a06fd228#commitcomment-46670712](https://github.com/a-poor/FeatureEng.jl/commit/a35f1552cf22494ff080673870f267d9a06fd228#commitcomment-46670712)

Thanks for your help!

---

<div class="post-metadata">

**Author:** ![mmiller](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mmiller/32/20805_2.png) [@mmiller](https://discourse.julialang.org/u/mmiller)\
**Post date:** [February 2, 2021, 10:30pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/6 "2021-02-02T22:30:09Z")

</div>

JuliaRegistrator should reply to your comment, like on this one:

[https://github.com/JuliaTesting/TestReports.jl/commit/cd0feec0bf1bd523caeb0949b1590c11f6ea78d1](https://github.com/JuliaTesting/TestReports.jl/commit/cd0feec0bf1bd523caeb0949b1590c11f6ea78d1)

I think if it doesn’t it means it’s not installed, have you clicked install here? [https://github.com/JuliaRegistries/Registrator.jl](https://github.com/JuliaRegistries/Registrator.jl)

---

<div class="post-metadata">

**Author:** ![apoor](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/apoor/32/21367_2.png) [@apoor](https://discourse.julialang.org/u/apoor)\
**Post date:** [February 3, 2021, 4:24pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/7 "2021-02-03T16:24:15Z")

</div>

I did but I initially triggered the first run with JuliaHub’s Registrator.

Do you think that could have caused the issue?

---

<div class="post-metadata">

**Author:** ![mmiller](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mmiller/32/20805_2.png) [@mmiller](https://discourse.julialang.org/u/mmiller)\
**Post date:** [February 3, 2021, 11:11pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/8 "2021-02-03T23:11:24Z")

</div>

I’m not sure, I think JuliaHub Registrator is the same application.

If you go to the Settings of your repository do you see JuliaTeam Registrator like in this picture below?

 ![image](https://global.discourse-cdn.com/julialang/original/3X/6/3/63285b4eb5f35e20b61dbac94c088069b96db95c.png)

---

<div class="post-metadata">

**Author:** ![apoor](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/apoor/32/21367_2.png) [@apoor](https://discourse.julialang.org/u/apoor)\
**Post date:** [February 10, 2021, 7:17pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/9 "2021-02-10T19:17:10Z")

</div>

No, it isn’t there! I thought it was installed when it wasn’t. Thank you for your help!

---

<div class="post-metadata">

**Author:** ![mmiller](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mmiller/32/20805_2.png) [@mmiller](https://discourse.julialang.org/u/mmiller)\
**Post date:** [February 10, 2021, 9:41pm UTC](https://discourse.julialang.org/t/help-with-package-documentation/54423/10 "2021-02-10T21:41:59Z")

</div>

You’re welcome!