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

Broken Links in data.atmosphere documentation #3098

Open
Parthmadan-1 opened this issue Jan 28, 2023 · 4 comments
Open

Broken Links in data.atmosphere documentation #3098

Parthmadan-1 opened this issue Jan 28, 2023 · 4 comments

Comments

@Parthmadan-1
Copy link
Contributor

Document Change needed

https://pecanproject.github.io/modules/data.atmosphere/docs/index.html

Documentation https://pecanproject.github.io/pecan//modules/data.atmosphere/inst/web/index.html
as well as PEcAn variable names https://pecanproject.github.io/pecan-documentation/master/met-data.html
have broken URL links.

@Parthmadan-1 Parthmadan-1 changed the title Broken Link of data.atmosphere documentation Broken Links in data.atmosphere documentation Jan 28, 2023
@infotroph
Copy link
Member

Thanks for reporting this! Unfortunately it's not as simple a fix as it looks: This is probably related to PecanProject/PecanProject.github.io#18 -- the package documentation pages are shamefully out of date (notice the linked docs are for PEcAn 1.6.0 and our last release was 1.7.2!), because they are not updated by the Github Actions build process the way the long-form PEcAn book is.

Anyone who wants to work on this could start by understanding how book.yml works and then work on modifying it to include compilation of the package docs.

@dlebauer
Copy link
Member

would it make sense to fix the broken links and open a separate issue for adding pkgdown to the documentation build process?

@infotroph
Copy link
Member

My sense is that the broken links are things that have been fixed by documentation updates in the newer versions, so trying to fix them manually would involve editing autogenerated code (i.e. it would be a waste of time).

Copy link

This issue is stale because it has been open 365 days with no activity.

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

No branches or pull requests

3 participants