Skip to content

Conversation

LecrisUT
Copy link
Collaborator

@LecrisUT LecrisUT commented Feb 23, 2023

Here is a temporary working version of the documentations:
https://spglib.readthedocs.io

Notice bottom left 🥳

The easiest way to integrate this is to delete this testing version and recreate it from this github organization. Also if we have a url like spglib.io we can link it or a subdomain (doc.spglib.io) to that.

Do we want to stick with the current theme or go with a rtd one like in readthedocs.io or something else?

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT LecrisUT added this to the 2.1 milestone Feb 23, 2023
@LecrisUT LecrisUT mentioned this pull request Feb 23, 2023
5 tasks
@atztogo
Copy link
Collaborator

atztogo commented Feb 24, 2023

Thanks @LecrisUT. I vote to the current theme.

The easiest way to integrate this is to delete this testing version and recreate it from this github organization.

I don't know well how readthedoc works. Does this mean the update of the documentation will be triggered from spglib organization?

@lan496
Copy link
Member

lan496 commented Feb 24, 2023

+1 for the current theme (sphinx-book-theme)

@LecrisUT
Copy link
Collaborator Author

So readthedocs automatically runs sphinx and it manages all versions internally. We can add this PR as is right now and then do the configuration after that.

@lan496 I've sent a request for the read the docs oauth, which should allow us to manage the webhooks automatically. Basically the setup and management are straightforward, we only need to setup the versioned documentation, otherwise everything is in the file of this PR.

@lan496
Copy link
Member

lan496 commented Feb 24, 2023

@LecrisUT I've approved readthedocs.org.

@LecrisUT LecrisUT merged commit bbb4f1e into spglib:develop Feb 24, 2023
@LecrisUT
Copy link
Collaborator Author

Oh, it didn't get webhook privilege (actually good design). I've invited you, maybe you can add it:

https://readthedocs.org/dashboard/spglib/integrations/
GitHub incoming webhook -> Resync webhook

@LecrisUT LecrisUT deleted the rtd branch February 24, 2023 09:47
@lan496
Copy link
Member

lan496 commented Feb 24, 2023

@LecrisUT I've resynchronized, which configured with status 200. Now it works?

@LecrisUT
Copy link
Collaborator Author

Hmm, can you try to add it again? We were still getting issue:

The project spglib doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.

@lan496
Copy link
Member

lan496 commented Feb 24, 2023

Sure. I've added and resynced github webhook again.

@LecrisUT
Copy link
Collaborator Author

Oh, it needed a bit of time to reset should be working now

@LecrisUT LecrisUT added enhancement Significant ehancements documentation labels Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Significant ehancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants