Skip to content

Commit 97095a9

Browse files
committed
Fix doc
1 parent e023172 commit 97095a9

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ _version.py
1212
build/
1313
dist/
1414
docs/src/examples
15+
docs/src/backreferences
1516
sg_execution_times.rst

docs/src/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,17 @@
6262
"reconstruction",
6363
"neighbors",
6464
]
65+
6566
sphinx_gallery_conf = {
67+
"backreferences_dir": "backreferences",
68+
"doc_module": ("skmatter",),
6669
"filename_pattern": "/*",
6770
"examples_dirs": [f"../../examples/{p}" for p in example_subdirs],
6871
"gallery_dirs": [f"examples/{p}" for p in example_subdirs],
6972
"min_reported_time": 60,
70-
# Make the code snippet for own functions clickable
71-
"reference_url": {"skmatter": None},
73+
"prefer_full_module": ["skamatter"],
74+
"reference_url": {"skamatter": None},
75+
"remove_config_comments": True,
7276
}
7377

7478
# Configuration for intersphinx: refer to the Python standard library

docs/src/getting-started.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ This guide illustrates the main functionalities that ``scikit-matter`` provides.
55
assumes a very basic working knowledge of how ``scikit-learn`` works. Please refer to
66
our :ref:`installation` instructions for installing ``scikit-matter``.
77

8-
For a detailed explaination of the functionalities, please look at the
9-
:ref:`selection-api`
10-
118
.. _getting_started-selection:
129

1310
Features and Samples Selection
@@ -22,7 +19,6 @@ Notebook Examples
2219
.. include:: examples/selection/index.rst
2320
:start-line: 4
2421

25-
2622
.. _getting_started-reconstruction:
2723

2824
Metrics

0 commit comments

Comments
 (0)