diff --git a/documentation/conf.py b/documentation/conf.py index df49ada..858da47 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -8,7 +8,7 @@ import sys from pathlib import Path -sys.path.insert(0, str(Path("..", "src").resolve())) +sys.path.insert(0, str(Path("..").resolve())) def autodoc_skip_member(app, what, name, obj, skip, options): @@ -48,7 +48,7 @@ def setup(app): ] templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/kaggle_api.py", "**/kaggle/models/*.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/kaggle/models/*.py"] source_suffix = { ".rst": "restructuredtext", @@ -61,7 +61,12 @@ def setup(app): html_theme = "alabaster" -apidoc_modules = [ - {"path": "../src/kaggle", "destination": "source/"}, -] autoclass_content = "both" +myst_heading_anchors = 2 +suppress_warnings = ["ref.unknown"] + +# -- Options for sphinx.ext.apidoc ------------------------------------------- +apidoc_module_dir = "../src/kaggle" +apidoc_output_dir = "source" +apidoc_excluded_paths = ["api/kaggle_api.py"] +apidoc_separate_modules = True diff --git a/documentation/index.rst b/documentation/index.rst index 21d5713..a475280 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -1,3 +1,5 @@ +.. _kaggle: + .. kaggle-api documentation master file, created by sphinx-quickstart on Thu Jun 26 22:53:21 2025. You can adapt this file completely to your liking, but it should at least diff --git a/documentation/intro.md b/documentation/intro.md index 8031b01..4f9dad0 100644 --- a/documentation/intro.md +++ b/documentation/intro.md @@ -1,3 +1,5 @@ +.. _kaggle: + # Kaggle CLI Documentation 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. Explore these tutorials to learn how to perform common tasks: -* [Tutorials](./tutorials.html) +* [Tutorials](./tutorials.md) * [Create a Dataset](./tutorials.md#tutorial-create-a-dataset) - * [Download a Dataset and Prepare for Analysis](./tutorials.md#tutorial-download-a-dataset-and-prepare-for-analysis) + * [Find and Download a Dataset](./tutorials.md#tutorial-find-and-download-a-dataset) * [Create a Model](./tutorials.md#tutorial-create-a-model) - * [Create a Model Variation](./tutorials.md#tutorial-create-a-model-instance) - * [Create a Model Variation Version](./tutorials.md#tutorial-create-a-model-instance-version) + * [Create a Model Variation](./tutorials.md#tutorial-create-a-model-variation) + * [Create a Model Variation Version](./tutorials.md#tutorial-create-a-model-variation-version) * [How to Submit to a Competition](./tutorials.md#tutorial-how-to-submit-to-a-competition) * [How to Submit to a Code Competition](./tutorials.md#tutorial-how-to-submit-to-a-code-competition)