Skip to content

Commit

Permalink
docs: Create a separate subsection for the skore project (#1240)
Browse files Browse the repository at this point in the history
  • Loading branch information
sylvaincom authored Jan 28, 2025
1 parent cf21491 commit e1fb0cc
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion examples/getting_started/README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Getting started
---------------

We recommend first having a look at the :ref:`example_quick_start` page. Then, the :ref:`example_skore_getting_started` provides an overall and gentle introduction to skore.
Overall and gentle introduction to skore.
5 changes: 5 additions & 0 deletions examples/skore_project/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Manipulating the skore project
------------------------------

These examples illustrate how to use the skore :class:`~skore.Project` to store many
kinds of objects, along with their past versions.
1 change: 1 addition & 0 deletions sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"../examples/getting_started",
"../examples/use_cases",
"../examples/model_evaluation",
"../examples/skore_project",
"../examples/technical_details",
]

Expand Down

0 comments on commit e1fb0cc

Please sign in to comment.