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

feat: Add /docs used to deploy documentation to GitHub Pages #553

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

thomass-dev
Copy link
Collaborator

@thomass-dev thomass-dev commented Oct 21, 2024

Following the official documentation, i propose the current workflow to build the sphinx documentation:

  1. (in the current iteration)
    Use a dedicated docs/ directory to store documentation artifacts that will be automatically rendered by GitHub on GitHub Pages.
    Every time something changes in this directory on the main branch, the GitHub Pages will be refreshed.
    So you can manually edit the site content on a PR, and push that PR on main to be applied.
    Documentation can be managed independently of release.

  2. (in the next iteration)
    Populate docs/ by triggering sphinx in a GitHub action when something changes in the skore/ directory.


image

@thomass-dev
Copy link
Collaborator Author

We should think about how to provide documentation for each version of skore (like the drop-down selection of python documentation) in a final iteration.

@thomass-dev thomass-dev marked this pull request as draft October 21, 2024 17:54
@thomass-dev thomass-dev force-pushed the gh-pages branch 6 times, most recently from 1a2e1d0 to 011a344 Compare October 21, 2024 19:55
@thomass-dev thomass-dev marked this pull request as ready for review October 21, 2024 20:04
@thomass-dev thomass-dev marked this pull request as draft October 22, 2024 07:43
@probabl-ai probabl-ai deleted a comment from github-actions bot Oct 22, 2024
@thomass-dev thomass-dev force-pushed the gh-pages branch 7 times, most recently from bba1990 to bf5c747 Compare October 23, 2024 09:55
@thomass-dev thomass-dev requested review from augustebaum and removed request for tuscland, rouk1 and sylvaincom October 23, 2024 12:58
@thomass-dev thomass-dev merged commit 53c94b8 into main Oct 23, 2024
14 checks passed
@thomass-dev thomass-dev deleted the gh-pages branch October 23, 2024 13:12
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.

1 participant