Stream: helpdesk (published)

Topic: ✔ Creating Documenter docs

view this post on Zulip Nils (Feb 06 2024 at 13:15):

I've asked this on Slack but with little success so far, so maybe someone here knows.

Following the Documenter docs and can't get even the simplest thing to run. I've got a package as follows:

src/
|-- SynthControl.jl
|-- SyntheticDiD.jl
docs/
|-- build
|-- src
|----- index.md
|-- make.jl

I successfully completed step 1 in the Documenter guide (a simple index.md file with just some markdown), but once I add a @docs block to the index file the build fails. I add:

## API
'''@docs # using the correct backticks in my actual code
SyntheticDiD
'''

and I get

[ Info: HTMLWriter: rendering HTML pages.
ERROR: LoadError: MissingRemoteError: unable to generate source url
  path: C:\Users\ngudat\.julia\packages\SynthControl\24pN4\src\SyntheticDiD.jl:1:20
  module: SynthControl

The remote section in the Documenter manual comes much later and talks about generating links to publicly hosted Git repos, when all I'm trying to do is to locally build my docs (for now). Any ideas why I'm getting this error when just trying to build the most basic docs?

view this post on Zulip Nils (Feb 06 2024 at 13:56):

Looks like it's solved by adding SynthControl to the /docs/Project.toml

view this post on Zulip Notification Bot (Feb 06 2024 at 17:07):

Sundar R has marked this topic as resolved.

Last updated: Nov 06 2024 at 04:40 UTC