Skip to content

Commit de70d65

Browse files
authored
Fix sphinx errors (#858)
Lines with "??" comment need to be verified. (Took a while to get a clean build and I don't want to lose these changes.)
1 parent 32d5085 commit de70d65

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

documentation/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import sys
99
from pathlib import Path
1010

11-
sys.path.insert(0, str(Path("..", "src").resolve()))
11+
sys.path.insert(0, str(Path("..").resolve()))
1212

1313

1414
def autodoc_skip_member(app, what, name, obj, skip, options):
@@ -48,7 +48,7 @@ def setup(app):
4848
]
4949

5050
templates_path = ["_templates"]
51-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/kaggle_api.py", "**/kaggle/models/*.py"]
51+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/kaggle/models/*.py"]
5252

5353
source_suffix = {
5454
".rst": "restructuredtext",
@@ -61,7 +61,12 @@ def setup(app):
6161

6262
html_theme = "alabaster"
6363

64-
apidoc_modules = [
65-
{"path": "../src/kaggle", "destination": "source/"},
66-
]
6764
autoclass_content = "both"
65+
myst_heading_anchors = 2
66+
suppress_warnings = ["ref.unknown"]
67+
68+
# -- Options for sphinx.ext.apidoc -------------------------------------------
69+
apidoc_module_dir = "../src/kaggle"
70+
apidoc_output_dir = "source"
71+
apidoc_excluded_paths = ["api/kaggle_api.py"]
72+
apidoc_separate_modules = True

documentation/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kaggle:
2+
13
.. kaggle-api documentation master file, created by
24
sphinx-quickstart on Thu Jun 26 22:53:21 2025.
35
You can adapt this file completely to your liking, but it should at least

documentation/intro.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kaggle:
2+
13
# Kaggle CLI Documentation
24

35
Welcome to the Kaggle CLI documentation. This guide provides detailed information on how to use the Kaggle command-line interface to interact with Kaggle's platform.
@@ -52,12 +54,12 @@ and it would be discovered by the client.
5254

5355
Explore these tutorials to learn how to perform common tasks:
5456

55-
* [Tutorials](./tutorials.html)
57+
* [Tutorials](./tutorials.md)
5658
* [Create a Dataset](./tutorials.md#tutorial-create-a-dataset)
57-
* [Download a Dataset and Prepare for Analysis](./tutorials.md#tutorial-download-a-dataset-and-prepare-for-analysis)
59+
* [Find and Download a Dataset](./tutorials.md#tutorial-find-and-download-a-dataset)
5860
* [Create a Model](./tutorials.md#tutorial-create-a-model)
59-
* [Create a Model Variation](./tutorials.md#tutorial-create-a-model-instance)
60-
* [Create a Model Variation Version](./tutorials.md#tutorial-create-a-model-instance-version)
61+
* [Create a Model Variation](./tutorials.md#tutorial-create-a-model-variation)
62+
* [Create a Model Variation Version](./tutorials.md#tutorial-create-a-model-variation-version)
6163
* [How to Submit to a Competition](./tutorials.md#tutorial-how-to-submit-to-a-competition)
6264
* [How to Submit to a Code Competition](./tutorials.md#tutorial-how-to-submit-to-a-code-competition)
6365

0 commit comments

Comments
 (0)