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

Implement GHA for building docs #199

Merged
merged 8 commits into from
Sep 23, 2023
Merged

Conversation

jGaboardi
Copy link
Member

@jGaboardi jGaboardi commented Sep 6, 2023

This PR resolves

@martinfleis
Copy link
Member

That stuff from _static is removed intentionally?

@jGaboardi
Copy link
Member Author

That stuff from _static is removed intentionally?

Not all of it. And what's up here vs. local doesn't seem to match. Let me look back at this. Not sure what went wrong...

@jGaboardi
Copy link
Member Author

@weikang9009 @martinfleis

I think I have resolved to file conflicts and can confirm the docs build locally from within docs/. However:

  1. When running make html 1 warning is being thrown:
    /Users/user/giddy/docs/RankBasedMethods.nblink:37: WARNING: undefined label: '/rankbasedmethods.nblink#inter--and-intra-regional-decomposition-of-kendall-tau'
    
  2. In the Tutorial notebooks the hyperlinks in the blue "This page was generated from" banner is being generated incorrectly, for example: https://github.com/pysal/giddy//Users/user/giddy/docs/MarkovBasedMethods.ipynb
Screenshot 2023-09-07 at 10 20 23 PM

Seems like both issues may be cropping up from nblink? Thoughts?

@martinfleis
Copy link
Member

I'm not familiar with nblink

@jGaboardi
Copy link
Member Author

I'm not familiar with nblink

Same...

@weikang9009 Do you mind if I refactor without using nblink? In other project we sync the notebooks directly in Makefile when running make html, e.g. here in mapclassify.

@weikang9009
Copy link
Member

@jGaboardi sounds good to me !

@jGaboardi
Copy link
Member Author

jGaboardi commented Sep 12, 2023

@weikang9009 this is ready for review.

  • all notebooks reviewed, cleaned, and rerun for Python 3.11
  • ensured local docs build runs without errors of doc warnings
  • swaps out nblink for rsync notebook syncing

@jGaboardi
Copy link
Member Author

@weikang9009 gentle ping for review on this.

@weikang9009 weikang9009 merged commit 92e3bbb into pysal:main Sep 23, 2023
6 checks passed
@weikang9009
Copy link
Member

@jGaboardi Thank you so much! I have changed the GitHub Page branch from main to the gh-pages branch. The doc website generated from the new github action looks great!

@jGaboardi jGaboardi deleted the implement_gha_docs branch September 23, 2023 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants