@@ -671,25 +671,25 @@ Documentation
671
671
672
672
We are glad to accept any sort of documentation:
673
673
674
- * function/method/class docstrings (also known as "API documentation") - these
675
- describe what the object does and details any parameters, attributes and
674
+ * ** function/method/class docstrings ** (also known as "API documentation") -
675
+ these describe what the object does and details any parameters, attributes and
676
676
methods. Docstrings live alongside the code in
677
- `sklearn/ <https://github.com/scikit-learn/scikit-learn/tree/main/sklearn >`_
678
- * user guide - these provide more detailed information about the algorithms
677
+ `sklearn/ <https://github.com/scikit-learn/scikit-learn/tree/main/sklearn >`_.
678
+ * ** user guide ** - these provide more detailed information about the algorithms
679
679
implemented in scikit-learn and generally live in the root
680
680
`doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc >`_ directory
681
681
and
682
- `doc/modules/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc/modules >`_
683
- * tutorials - these introduce various statistical learning and machine learning
682
+ `doc/modules/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc/modules >`_.
683
+ * ** tutorials ** - these introduce various statistical learning and machine learning
684
684
concepts and are located in
685
- `doc/tutorial <https://github.com/scikit-learn/scikit-learn/tree/main/doc/tutorial >`_
686
- * examples - these provide full code examples that may demonstrate the use of
687
- scikit-learn modules, compare different algorithms or discuss their
685
+ `doc/tutorial <https://github.com/scikit-learn/scikit-learn/tree/main/doc/tutorial >`_.
686
+ * ** examples ** - these provide full code examples that may demonstrate the use
687
+ of scikit-learn modules, compare different algorithms or discuss their
688
688
interpretation etc. Examples live in
689
689
`examples/ <https://github.com/scikit-learn/scikit-learn/tree/main/examples >`_
690
- * other reStructuredText documents (like this one) - provide various other
690
+ * ** other reStructuredText documents ** (like this one) - provide various other
691
691
useful information (e.g., our guide to contributing) and live in
692
- `doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc >`_
692
+ `doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc >`_.
693
693
694
694
You can edit the documentation using any text editor, and then generate the
695
695
HTML output by following :ref: `building_documentation `. The resulting HTML files
0 commit comments