Fix documentation.

alefnula · alefnula · commit 1d9c3f771bad · 2024-05-10T02:08:17.000+01:00
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -1,8 +1,6 @@
-```eval_rst
 PapersWithCode Client Class
 ===========================
 
 .. automodule:: paperswithcode.client
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -1,9 +1,7 @@
 # PapersWithCode Client api documentation
 
-```eval_rst
 .. toctree::
    :maxdepth: 3
 
-   models/index.md
-   client.md
-```
+   models/index.rst
+   client.rst
diff --git a/docs/api/models/conference.rst b/docs/api/models/conference.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Conference Models
 =================
 
 .. automodule:: paperswithcode.models.conference
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/dataset.rst b/docs/api/models/dataset.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Dataset Models
-===============
+==============
 
 .. automodule:: paperswithcode.models.dataset
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/evaluation.rst b/docs/api/models/evaluation.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Evaluation Table Models
 =======================
 
 .. automodule:: paperswithcode.models.evaluation
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/index.md b/docs/api/models/index.md
diff --git a/docs/api/models/index.rst b/docs/api/models/index.rst
@@ -0,0 +1,13 @@
+PapersWithCode Client Models
+============================
+
+.. toctree::
+   :maxdepth: 3
+
+   paper.rst
+   conference.rst
+   task.rst
+   dataset.rst
+   method.rst
+   repository.rst
+   evaluation.rst
diff --git a/docs/api/models/method.rst b/docs/api/models/method.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Method Models
 =============
 
 .. automodule:: paperswithcode.models.method
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/paper.rst b/docs/api/models/paper.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Paper Models
 ============
 
 .. automodule:: paperswithcode.models.paper
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/repository.rst b/docs/api/models/repository.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Repository Models
 =================
 
 .. automodule:: paperswithcode.models.repository
     :members:
     :no-undoc-members:
-```
diff --git a/docs/api/models/task.rst b/docs/api/models/task.rst
@@ -1,8 +1,6 @@
-```eval_rst
 Task Models
 ===========
 
 .. automodule:: paperswithcode.models.task
     :members:
     :no-undoc-members:
-```
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,80 +1,50 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+# Add project root to pythonpath
 import os
 import sys
-from recommonmark.transform import AutoStructify
 
-# Add project root to pythonpath
 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 from paperswithcode.version import __version__
 
 
-# -- Project information -----------------------------------------------------
-
 project = "PapersWithCode Client"
-copyright = "2020, Viktor Kerkez <alefnula@gmail.com>"
+copyright = "2024, Viktor Kerkez <alefnula@gmail.com>"
 author = "Viktor Kerkez <alefnula@gmail.com>"
-
-# The full version, including alpha/beta/rc tags
-version = __version__
 release = __version__
 
-
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
-    "sphinx.ext.todo",
-    "sphinx.ext.mathjax",
-    "sphinx.ext.ifconfig",
-    "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
-    "sphinx.ext.githubpages",
-    "recommonmark",
+    "myst_parser",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = ".md"
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
+templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = "sphinx_rtd_theme"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-
 # autodoc
 
 autoclass_content = "both"
@@ -83,21 +53,3 @@
     "special-members": "__init__",
     "undoc-members": True,
 }
-
-
-# recommonmark
-
-
-def setup(app):
-    app.add_config_value(
-        "recommonmark_config",
-        {
-            "enable_auto_toc_tree": True,
-            "auto_toc_tree_section": True,
-            "enable_math": True,
-            "enable_inline_math": True,
-            "enable_eval_rst": True,
-        },
-        True,
-    )
-    app.add_transform(AutoStructify)
diff --git a/docs/evaluations.md b/docs/evaluations.md
diff --git a/docs/evaluations.rst b/docs/evaluations.rst
@@ -0,0 +1,5 @@
+Mirroring your competition on Papers with Code
+==============================================
+
+For more information on how to mirror your competition, please refer to the
+`README file in the paperswithcode-client repository <https://github.com/paperswithcode/paperswithcode-client>`_.
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,31 @@
+.. PapersWithCode Client documentation master file, created by
+   sphinx-quickstart on Fri May 10 01:40:37 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PapersWithCode Client's documentation!
+=================================================
+
+This documentation details how to use the ``paperswithcode`` library to connect 
+with `PapersWithCode <http://www.paperswithcode.com>`_. 
+
+.. toctree::
+   :maxdepth: 2
+
+   installation.rst
+   quickstart.rst
+   evaluations.rst
+
+
+.. toctree::
+   :maxdepth: 4
+
+   api/index.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,19 @@
+Installation
+============
+
+The library requires Python 3.6+ and can be installed via pip:
+
+.. code-block:: shell
+
+    $ pip install paperswithcode-client
+
+
+Usually you would want to create a virtual environment before installing the
+library:
+
+
+.. code-block:: shell
+
+    $ python3 -m venv pwc
+    $ source pwc/bin/activate
+    $ pip install paperswithcode-client
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/quickstart.md b/docs/quickstart.md
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
diff --git a/requirements-dev.txt b/requirements-dev.txt
