Doc - Backbone for API Reference

This commit is contained in:
Anthony MOI
2020-10-06 14:31:16 -04:00
committed by Anthony MOI
parent 7eb0a9255e
commit 3ee54766e3
7 changed files with 69 additions and 16 deletions

View File

@ -0,0 +1 @@
The node API has not been documented yet.

View File

@ -0,0 +1,2 @@
.. autoclass:: tokenizers.Tokenizer
:members:

View File

@ -0,0 +1,14 @@
API Reference
====================================================================================================
.. only:: python
.. include:: python_reference.inc
.. only:: rust
.. include:: rust_reference.inc
.. only:: node
.. include:: node_reference.inc

View File

@ -0,0 +1 @@
The Rust API has not been documented yet.

View File

@ -30,7 +30,7 @@ release = "0.9.0"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

View File

@ -34,6 +34,10 @@ Components:
pipeline
components
.. toctree::
api/reference
Load an existing tokenizer:
----------------------------------------------------------------------------------------------------