# Documentation based on docstring, and deploy to juliahub

**URL:** <https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715>\
**Category:** New to Julia\
**Tags:** question, documenter\
**Created:** [February 24, 2024, 11:19pm UTC](https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715 "2024-02-24T23:19:22Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![perebalazs](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/perebalazs/32/49662_2.png) [@perebalazs](https://discourse.julialang.org/u/perebalazs)\
**Post date:** [February 24, 2024, 11:19pm UTC](https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715/1 "2024-02-24T23:19:22Z")

</div>

I made a Julia package [LowLevelFEM](https://github.com/perebalazs/LowLevelFEM.jl) and tried to make documentation for it. I used docstings in src file. `docs/build/index.html` was generated with `Documenter` julia package and `@audodocs` macro inside `index.md`. Now I want to publish the html documentation somewhere. It is not clear where: [https://perebalazs.github.io/LowLevelFEM.jl/](https://perebalazs.github.io/LowLevelFEM.jl/) or [https://docs.juliahub.com/General/LowLevelFEM/stable/](https://docs.juliahub.com/General/LowLevelFEM/stable/). Each of them is exists, but the former does not contain the docstrings from the source file, the latter is empty. After two days of trying I copied the `make.jl` and `ci.yml` files from other packages where doc pages were similar which I wanted. (e.g. [https://github.com/JuliaHEP/UnROOT.jl/blob/main/.github/workflows/ci.yml](https://github.com/JuliaHEP/UnROOT.jl/blob/main/.github/workflows/ci.yml), [https://github.com/NumSoftware/Amaru.jl/blob/main/docs/make.jl](https://github.com/NumSoftware/Amaru.jl/blob/main/docs/make.jl)).

I don’t understand why I can’t see the `docs/build/index.html` file on one of the sites (github or juliahub)? What have I done wrong?

---

<div class="post-metadata">

**Author:** ![mkitti](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mkitti/32/12459_2.png) [@mkitti](https://discourse.julialang.org/u/mkitti)\
**Post date:** [February 25, 2024, 12:08am UTC](https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715/2 "2024-02-25T00:08:51Z")

</div>

Did you configure Github pages to point to the gh-pages branch?

The page does seem to be present.

> <https://github.com/perebalazs/LowLevelFEM.jl/blob/gh-pages/dev%2Findex.html>

> **[Hosting Documentation · Documenter.jl](https://documenter.juliadocs.org/stable/man/hosting/#gh-pages-Branch)**
>
> Documentation for Documenter.jl.

> **[Configuring a publishing source for your GitHub Pages site - GitHub Docs](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)**
>
> You can configure your GitHub Pages site to publish when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site.

---

<div class="post-metadata">

**Author:** ![perebalazs](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/perebalazs/32/49662_2.png) [@perebalazs](https://discourse.julialang.org/u/perebalazs)\
**Post date:** [February 25, 2024, 7:53am UTC](https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715/3 "2024-02-25T07:53:14Z")

</div>

> Did you configure Github pages to point to the gh-pages branch?

Thanks, that was missing.

---

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [February 25, 2024, 9:04am UTC](https://discourse.julialang.org/t/documentation-based-on-docstring-and-deploy-to-juliahub/110715/4 "2024-02-25T09:04:55Z")

</div>

Another tutorial that includes the documentation part: [11 - Developing Julia packages - Julia language: a concise tutorial](https://syl1.gitbook.io/julia-language-a-concise-tutorial/language-core/11-developing-julia-packages)

You host your documentation on github and then either on juliahub they make “another copy” of it, or you direcly instruct juliahub on where is your package documentation on github .