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

Fix Readthedocs #1290

Merged
merged 2 commits into from
Jan 26, 2023
Merged

Fix Readthedocs #1290

merged 2 commits into from
Jan 26, 2023

Conversation

VeckoTheGecko
Copy link
Contributor

Fixes #1288

Deployment on my fork is visible here: https://veckoparcels.readthedocs.io/en/patch-rtd/

@erikvansebille
Copy link
Member

Thanks for this PR, @VeckoTheGecko. Your idea to automatically link through readthedocs.io is a good one! I forgot that we had a place for parcels there in the past...

One question; does the .readthedocs.yaml file need to be in the project root? Is there no way to put it in the docs folder and point the readthedocs server there? That would keep the project file tree a bit cleaner

@VeckoTheGecko
Copy link
Contributor Author

I had the same thought, but unfortunately it has to be in the project root.

Fixed the following error which resulted in missed documentation.

WARNING: autodoc: failed to import module 'plottrajectoriesfile' from module scripts'; the following exception was raised:
No module named 'scripts'
@erikvansebille
Copy link
Member

OK, is this ready to be merged now?

@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Jan 26, 2023

Good to go!

I'm not sure if additional config needs to be done on your end (as the owner for the parcels project on RTD). Happy to wait and see post-merge

@erikvansebille erikvansebille merged commit 0aea203 into OceanParcels:master Jan 26, 2023
@VeckoTheGecko
Copy link
Contributor Author

Looks like the official deployment isn't updating. I've updated my fork to master and that deployment is good.

It would be good to check the config/builds on RTD.

@erikvansebille
Copy link
Member

I manually triggered the build, so the pages seem to now be updated. I'll have to check how to auto-build (via a hook?)

@erikvansebille
Copy link
Member

Hmm, and I now also see that the left side panel (with the table of content etc) doesn't work at https://parcels.readthedocs.io/en/latest/#. Did you do anything special to get that working on your fork, @VeckoTheGecko?

@VeckoTheGecko
Copy link
Contributor Author

Strange. Are there any errors visible in the build logs?

I didn't do any additional configuration on my side outside of this PR.

I don't have hooks/automation rules, though I do have an integration (which I think was added by default on setup). Perhaps that could be it?

@erikvansebille
Copy link
Member

I haven't changed anything, but the disbar seems to work now. So all good after all. I just also updated the links on oceanparcels.org, to link directly to https://parcels.readthedocs.io/

@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Jan 30, 2023

Super minor detail, but might be worth disabling prior versions listed in the image as the deployment is broken on those tags.

I don't think its worth merging this branch into those tags, but just to disable those builds in RTD and use the tags for versions moving forward.

image

@erikvansebille
Copy link
Member

I don't think its worth merging this branch into those tags, but just to disable those builds in RTD and use the tags for versions moving forward.

Good point, I now removed all these older versions for which the RTD integration was not working yet

@VeckoTheGecko VeckoTheGecko deleted the patch/rtd branch June 7, 2023 06:11
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 this pull request may close these issues.

Fix documentation website deployment
2 participants