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

[Feature] Hosting Documentation #27

Closed
adamjankaczmarek opened this issue Jan 5, 2023 · 2 comments · Fixed by #59
Closed

[Feature] Hosting Documentation #27

adamjankaczmarek opened this issue Jan 5, 2023 · 2 comments · Fixed by #59
Milestone

Comments

@adamjankaczmarek
Copy link
Collaborator

No description provided.

@adamjankaczmarek adamjankaczmarek added this to the First Release milestone Jan 5, 2023
@adamwawrzynski
Copy link
Collaborator

Where should we host documentation @adamjankaczmarek? On GitHub pages, Read the Docs or something else?

@adamwawrzynski
Copy link
Collaborator

Read the Docs is easy to use. You need to grant permissions to ReadtheDocs (it installs webhooks to automatically detect changes to documentation in the repository; explained here). It would be necessary to grant RtD permissions for the SML group that contains the repository with XAI. The tutorial describes how to configure the project, how to enable documentation building for PRs, versioning. Using versioning would require us to create separate branches at each release for major and minor version changes and manually activate them in the RtD project.

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 a pull request may close this issue.

2 participants