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
Move to single directory and auto generate/publish docs #1246
Comments
I can see that this action is running, but where is it running from? The workflow is not showing up in the |
Ahhh maybe because I don't have access to |
Yup, that is the mystery. |
Let's @knaaptime and @martinfleis in on this for potential insight. |
yes, see the top of this issue. |
I think the reason the docs were not getting updated (2.4 was the last version) is that I forgot to run the sync step last release. I just did a pr that has the sync #1247 which should update now. But moving forward it would be nice to move away from this two-step docsrc -> docs dance. |
we solved this in the other packages, so this is a straightforward fix |
The other complication I want to address is that with the move to versioneer, I'm not quite sure how to have the right tag on the docs when we build them. This is probably another good reason to automate the doc build. |
martin might have some insight. Ive seen this raised over in geopandas too |
the release is ready to go, but I wanted to see if we could dial in the doc build as part of the release. Ideally, we want to be able to update the docs if needed, but have the tag match the release tag. |
Tag the repository and run |
Yeah, because in the branch you are using, the latest tag is 2.2.0. And then there's 215 commits after that. |
I have a draft release on gh that will create the v2.6.0 tag when published. |
So if I publish the release, I can then update the docs and it should grab the new tag? |
Yes, that is the theory and my experience. We can always fix docs later if that won't work as expected. |
release action appears to work for pypi |
Try reloading, I see 2.6.0 |
Might be another chance to look into #1216? |
Currently we build the html docs out of
docsrc
and use a sync script to copy over todocs
and publish via gh-pages:It would be great to refactor this to use the gh-pages branch approach to publish and build out of a single directory.
I'm assuming this would enable the bot action to work as intended.
The text was updated successfully, but these errors were encountered: