Skip to content

Cannot build documentation locally #545

Description

@andreacassioli

Before filing

  • I searched the existing issues and did not find a duplicate.
  • I checked the latest version of the documentation on develop.

Kind of problem

  • Documentation is missing entirely
  • Documentation is incorrect or out of date
  • Explanation is unclear or confusing
  • Example does not compile
  • Example compiles but does not produce the documented result
  • Dead link or broken cross-reference
  • Other (specify below)

Where is the issue?

I cannot compile the docs locally.

What is wrong, missing, or unclear?

  1. there seems to be a dependency to an npm packages @cppalliance/antora-downloads-extension that is not documented as far as I can see (is this packages really needed?)
  2. I have followed the docs and, after step one (building example), I did
[andrea@andrea-dell boost (master *)]$ cd libs/graph
[andrea@andrea-dell graph (rcsp-new-interface-overloads *)]$ npx antora doc/graph-playbook.yml 
npx: installed 159 in 13.081s
[14:57:44.389] FATAL (antora): Local content source must be a git repository: /home/andrea/Code/boost/libs (url: ..)
Add the --stacktrace option to see the cause of the error.

Not sure what I doing wrong.

What did you expect to find?

NA

Suggested wording (optional)

NA

Are you willing to help?

  • I'd like to submit a docs pull request.
  • I can review a candidate fix.
  • I'm only reporting the issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions