Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation is outdated due to a build error #2065

Open
M0NsTeRRR opened this issue Apr 11, 2024 · 6 comments · Fixed by #2066
Open

Documentation is outdated due to a build error #2065

M0NsTeRRR opened this issue Apr 11, 2024 · 6 comments · Fixed by #2066

Comments

@M0NsTeRRR
Copy link
Contributor

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
Copy link
Contributor Author

M0NsTeRRR commented Apr 11, 2024

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

@ktbyers
Copy link
Contributor

ktbyers commented Apr 11, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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 ktbyers reopened this Apr 11, 2024
@ktbyers
Copy link
Contributor

ktbyers commented Apr 11, 2024

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
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants