search

napalm-automation / napalm

Network Automation and Programmability Abstraction Layer with Multivendor support
Apache License 2.0
2.24k stars 552 forks source link

Documentation is outdated due to a build error #2065

Closed M0NsTeRRR closed 3 months ago

M0NsTeRRR commented 5 months ago

Hello,

Documentation hosted on RTD is outdated, there is an issue when building the documentation

https://readthedocs.org/projects/napalm/builds

Last successfull operation was 7 months ago

M0NsTeRRR commented 5 months ago

We should have a failure notification from RTD and it shoulds notify somewhere to prevents it again. Linked to #1697

ktbyers commented 5 months ago

Read the docs changed things...

We are announcing the deprecation of build.image config key in favor of build.os. Read the Docs will 
start requiring a build.os config key for all projects in order to build documentation successfully. We 
will start failing builds for projects not using “build.os” in their config file on October 16, 2023.

The error is due to the missing build.os.

M0NsTeRRR commented 5 months ago

Read the docs changed things...

We are announcing the deprecation of build.image config key in favor of build.os. Read the Docs will 
start requiring a build.os config key for all projects in order to build documentation successfully. We 
will start failing builds for projects not using “build.os” in their config file on October 16, 2023.

The error is due to the missing build.os.

Yes I was creating the PR about it :)

M0NsTeRRR commented 5 months ago

Hmhm, it didn't trigger a rebuild on the RTD site. Is the webhook still configured? I think there might be another issue. The last build was 5 months ago, but you've pushed to develop many times since then.

ktbyers commented 5 months ago

I will need @mirceaulinic to look at it (as I don't have access on the read-the-docs side). GitHub webhooks is stating a 400 error.

I suspect readthedocs changed things / broke things on their side.

M0NsTeRRR commented 5 months ago

Documentation build is now fixed. If we intend to have documentation for both versions 5.X and 4.X, we need to port changes similar to what @mirceaulinic did for the master branch. Otherwise, we can consider closing the issue.