Documenter.jl site not displaying full set of features from github, the basic static features only without links and content strcuture

General Usage
,
1

I am starting a new repository on Github, https://github.com/mantzaris/BenchmarkDataNLP.jl, and it compiles and the Github actions work etc, but on the site’s deployment: https://mantzaris.github.io/BenchmarkDataNLP.jl/, you can see that the documentation has a limited set of the page’s expected structure, the links are not shown etc but the page is there being served.

This is the make.jl:

using Documenter
using BenchmarkDataNLP

makedocs(
    sitename = "BenchmarkDataNLP",
    format =  Documenter.HTML(),
    modules = [BenchmarkDataNLP],
)

deploydocs(
    repo = "github.com/mantzaris/BenchmarkDataNLP.jl.git"
)

the index.md:

# BenchmarkDataNLP.jl

\```@contents

\```

## Introduction

`BenchmarkDataNLP.jl` is ...

## Functions

\```@autodocs
Modules = [BenchmarkDataNLP]
Private = false
Order = [:function]
\```

is there something I am missing?
could someone take a look at the code and spot what is missing or astray? docs code link

is it maybe the documentation.yml that is not set up correctly to point to all the build files? The actions all pass with green.

2

The issue was that on the Pages setting of the repo, in the subsection ’ Build and deployment’, the branch was main but needed to be the gh-pages and the directory to be from root or /docs worked but toot ‘/’ is considered the correct solution. After that all shows as expected.

1 Like