diff --git a/docs/conf.py b/docs/conf.py index 3c3957e..582b45d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,20 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.mathjax', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', + 'sphinx_copybutton', + 'autoapi.extension', +] + +autosummary_generate = True templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] @@ -23,5 +36,7 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] + +autoapi_dirs = ['../angle_emb'] diff --git a/docs/index.rst b/docs/index.rst index 48f16a0..80b5dfd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -73,3 +73,13 @@ AnglE is also a general sentence embedding inference framework, allowing for inf :maxdepth: 2 :caption: Contents: + notes/quickstart.rst + notes/installation.rst + notes/pretrained_models.rst + notes/training.rst + notes/citation.rst + + +.. toctree:: + :maxdepth: 1 + :caption: APIs: diff --git a/docs/notes/installation.rst b/docs/notes/installation.rst index 3f48a5f..8923983 100644 --- a/docs/notes/installation.rst +++ b/docs/notes/installation.rst @@ -1,4 +1,4 @@ -Installation +⬇️ Installation ================================ diff --git a/docs/notes/pretrained_models.rst b/docs/notes/pretrained_models.rst index 0e0dc36..a4dd39c 100644 --- a/docs/notes/pretrained_models.rst +++ b/docs/notes/pretrained_models.rst @@ -1,10 +1,10 @@ 🏛️ Official Pretrained Models -=========================== +================================ BERT-based models: ------------------- +------------------------------ +------------------------------------+-------------+-------------------+--------------------------+ | 🤗 HF | Max Tokens | Pooling Strategy | Scenario | @@ -19,7 +19,7 @@ BERT-based models: LLM-based models: ------------------ +------------------------------ +------------------------------------+-----------------------------+------------------+--------------------------+------------------+---------------------------------+ | 🤗 HF (lora weight) | Backbone | Max Tokens | Prompts | Pooling Strategy | Scenario | diff --git a/docs/notes/quick_start.rst b/docs/notes/quickstart.rst similarity index 100% rename from docs/notes/quick_start.rst rename to docs/notes/quickstart.rst diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..dbcfaae --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +sphinx +sphinx-rtd-theme +sphinx-copybutton +sphinx-autoapi \ No newline at end of file