fix docs

balins · Sep 1, 2024 · 949cd90 · 949cd90
1 parent acd5cbc
commit 949cd90
Show file tree

Hide file tree

Showing 41 changed files with 612 additions and 789 deletions.
diff --git a/doc/_static/img/index_api.svg b/doc/_static/img/index_api.svg
diff --git a/doc/_static/img/index_examples.svg b/doc/_static/img/index_examples.svg
diff --git a/doc/_static/img/index_getting_started.svg b/doc/_static/img/index_getting_started.svg
diff --git a/doc/_static/img/index_user_guide.svg b/doc/_static/img/index_user_guide.svg
diff --git a/doc/api.rst b/doc/api.rst
@@ -4,37 +4,18 @@
 API Reference
 #############
 
-This is an example on how to document the API of your own project.
+API reference for the `fsvm` package.
 
 .. currentmodule:: fsvm
 
-Estimator
+FuzzySVC
 =========
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   TemplateEstimator
-
-Transformer
-===========
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-   TemplateTransformer
-
-Predictor
-=========
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    TemplateClassifier
-
+   FuzzySVC
 
 Utilities
 =========

diff --git a/doc/conf.py b/doc/conf.py
@@ -10,9 +10,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 from importlib.metadata import version as get_version
 
-project = "Scikit-learn Project Template"
-copyright = "2016, V. Birodkar"
-author = "V. Birodkar"
+project = "fsvm"
+copyright = "2024, J. Baliński"
+author = "J. Baliński"
 release = get_version("fsvm")
 version = ".".join(release.split(".")[:3])
 
@@ -51,24 +51,22 @@
     "css/fsvm.css",
 ]
 html_sidebars = {
-    "quick_start": [],
-    "user_guide": [],
+    "api": [],
     "auto_examples/index": [],
 }
 
 html_theme_options = {
     "external_links": [],
     "github_url": "https://github.com/balins/fsvm",
-    # "twitter_url": "https://twitter.com/pandas_dev",
     "use_edit_page_button": True,
     "show_toc_level": 1,
     # "navbar_align": "right",  # For testing that the navbar items align properly
 }
 
 html_context = {
-    "github_user": "scikit-learn-contrib",
-    "github_repo": "project-template",
-    "github_version": "master",
+    "github_user": "balins",
+    "github_repo": "fsvm",
+    "github_version": "main",
     "doc_path": "doc",
 }