-
Notifications
You must be signed in to change notification settings - Fork 40
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
docs: add documentation #8
base: master
Are you sure you want to change the base?
Conversation
Yes, I agree with RDT. |
Perfect then if we go toward RDT, could you from you side start a RDT documentation project and activate the "build on PR" so that I can check the build from here ? |
Perfect, I think i've done the RTD integration. I'll switch to #7 so we can merge that and try it out |
update docs with nox builds
Is the RTD integration working? https://readthedocs.org/projects/ipython-gpt/builds/ |
my last commit should have triggered a PR build, can you confirm you applied this: https://docs.readthedocs.io/en/stable/pull-requests.html |
Done |
The pre-build is up and running: https://ipython-gpt--8.org.readthedocs.build/en/8/index.html Let me know what you think (I'll stop for today and see tomorrow to execute the cells of the usage section and send users to binder/collab) |
WIP
Open question: where do you want to share the documentation, ReadTheDocs or github page ?
I personnaly prefers RDT as ther offer multiple sweet tools like automatic PR builds