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.
This PR contains the necessary changes to migrate to our new documentation platform, GitBook.
Previously, all notebooks were exported as markdown files during CI. Now, we will need to make changes to the notebooks and export them to a markdown file before committing the changes.
If you update 1 notebook you could use the quarto CLI and run the following command to update it from the terminal.
If you update many notebooks and you want to convert them all at once, you can run the following command on the terminal.
All files from the
doc/source
directory have been moved one lovely up, and all files related toreadthedocs
orsphinx
have been deleted.No changed have been made to the CI/CD pipeline. If we are running a command or several related to
readthedocs
and/orsphinx
, these will need to be removed.Lastly, there are no API references in this new documentation. These can be added later on or users can go to the source code to learn more about the implementation of a method.