feat: Add /docs
used to deploy documentation to GitHub Pages
#553
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the official documentation, i propose the current workflow to build the sphinx documentation:
(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.
(in the next iteration)
Populate
docs/
by triggeringsphinx
in a GitHub action when something changes in theskore/
directory.