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

docs: add documentation #8

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

Conversation

12rambau
Copy link
Contributor

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

@santiagobasulto
Copy link
Owner

Yes, I agree with RDT.

@12rambau 12rambau mentioned this pull request Apr 24, 2023
@12rambau
Copy link
Contributor Author

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 ?
Also I would need the nox build to create local venv and check RDT requirements in isolation. Is there anything I should add to #7 ? If not I'll wait for it to be merge to master and rebase before moving forward

@santiagobasulto
Copy link
Owner

Perfect, I think i've done the RTD integration. I'll switch to #7 so we can merge that and try it out

@santiagobasulto
Copy link
Owner

Is the RTD integration working? https://readthedocs.org/projects/ipython-gpt/builds/

@12rambau
Copy link
Contributor Author

my last commit should have triggered a PR build, can you confirm you applied this: https://docs.readthedocs.io/en/stable/pull-requests.html

@santiagobasulto
Copy link
Owner

Done

@12rambau
Copy link
Contributor Author

12rambau commented Apr 27, 2023

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)

@12rambau 12rambau marked this pull request as ready for review May 22, 2023 14:52
@12rambau 12rambau marked this pull request as draft May 22, 2023 14:52
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.

2 participants