search

FRRouting / frr

The FRRouting Protocol Suite
https://frrouting.org/
Other
3.27k stars 1.24k forks source link

How to build docs? #16763

Closed marek22k closed 22 hours ago

marek22k commented 1 week ago

Description

Hello,

I am trying to create the HTML documentation, but without success: 

$ git clone --branch frr-10.1 --depth 1 https://github.com/FRRouting/frr.git
$ cd frr/doc/
$ make html
make[1]: *** No rule to make target 'doc/user/_build/html/.buildinfo'.  Stop.
make: *** [Makefile:6: html] Error 2

Version

$ git describe --always
frr-10.1

How to reproduce

Try to build the docs

Expected behavior

The documentation is being built.

Actual behavior

A error appears.

Additional context

No response

Checklist

mjstapp commented 1 week ago

try make html at the top level, rather than down in the doc/ subdirectories?

On Sat, Sep 7, 2024 at 9:32 PM Marek Küthe @.***> wrote:

Description

Hello,

I am trying to create the HTML documentation, but without success:

$ git clone --branch frr-10.1 --depth 1 https://github.com/FRRouting/frr.git $ cd frr/doc/ $ make html make[1]: No rule to make target 'doc/user/_build/html/.buildinfo'. Stop. make: [Makefile:6: html] Error 2

Version

$ git describe --always frr-10.1

How to reproduce

Try to build the docs

Expected behavior

The documentation is being built.

Actual behavior

A error appears.

Additional context

No response

Checklist

  • [X] I have searched the open issues for this bug.
  • [X] I have not included sensitive information in this report.

— Reply to this email directly, view it on GitHub https://github.com/FRRouting/frr/issues/16763, or unsubscribe https://github.com/notifications/unsubscribe-auth/AETTDMAZYTGNRRY5VJERTRDZVOSMFAVCNFSM6AAAAABN2QCWEOVHI2DSMVQWIX3LMV43ASLTON2WKOZSGUYTEMJUHAZTANY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

marek22k commented 1 week ago

Mhh, that would be quite unusual for a Sphinx documantation. But I can give it a try:

$ make html
make: *** No rule to make target 'html'.  Stop.
mjstapp commented 1 week ago

it works for me, with more-or-less master? where were you in the example you posted just above - at the top level of the frr sandbox?

marek22k commented 1 week ago

it works for me, with more-or-less master? where were you in the example you posted just above - at the top level of the frr sandbox?

In the frr root of branch frr-10.1. Since I only want to build the documentation, I have not executed ./configure or anything similar.

mjstapp commented 1 week ago

ah, yes: you'll need to bootstrap and configure, I think, in order to get working makefiles

it works for me, with more-or-less master? where were you in the example you posted just above - at the top level of the frr sandbox?

In the frr root of branch frr-10.1. Since I only want to build the documentation, I have not executed ./configure or anything similar.

marek22k commented 1 week ago

That actually works. Is there a way to configure FRR without libyang (and other dependencies) (i.e. just to build the documentation)?

mjstapp commented 1 week ago

That actually works. Is there a way to configure FRR without libyang (and other dependencies) (i.e. just to build the documentation)?

sorry, that I don't know - I only configure frr in order to build frr.

donaldsharp commented 1 week ago

Yeah, probably someone could figure this out and make it work. Not necessarily worth our time to go down that path though of figuring out how to let make html work without a functioning libyang setup.

marek22k commented 1 week ago

I was able to successfully build the documentation with the Woodpecker CI. However, strangely, the libyang2-dev package from the Debian repo gives an error at ./configure. If anyone is interested, here is a Zeal/Dash feed for offline documentation: https://mark22k.codeberg.page/zeal-docs/@frr/FRR.xml