Running Documenter after PkgTemplates, what to put for "sitename"

New to Julia
, ,
1

I attempted to use PkgTemplates to create a package, running the following:

t = Template(;
    dir="~/code",
    plugins=[
        Git(; manifest=true, ssh=true),
        Codecov(),
        TravisCI(; x86=true),
        Documenter{TravisCI}(),
    ],
)
t("Mypackage")

Creates a project directory “Mypackage”, which already has this partial structure:
Fig.1
docs

Also when I go to the repo on github there are buttons:
Fig.2
widg

Now I have added some types and methods and I need to update this existing documentation.

According to the Documenter tutorial, that means running:

makedocs(sitename="My Documentation")

But since the template is already done, I’m assuming the sitename is not arbitrary.
How do I make sure sitename matches stuff that PkgTemplates put in Fig.1 and Fig.2 so when I click on those buttons my actual docs show up?

2

sitename just determines what goes at the top of the sidebar and in the page <title> in the docs. So you can (should) just change that to e.g. the package name.

1 Like