mirror of
https://github.com/mii443/tokenizers.git
synced 2025-08-22 16:25:30 +00:00
Doc - Backbone for API Reference
This commit is contained in:
1
docs/source/api/node_reference.inc
Normal file
1
docs/source/api/node_reference.inc
Normal file
@ -0,0 +1 @@
|
||||
The node API has not been documented yet.
|
2
docs/source/api/python_reference.inc
Normal file
2
docs/source/api/python_reference.inc
Normal file
@ -0,0 +1,2 @@
|
||||
.. autoclass:: tokenizers.Tokenizer
|
||||
:members:
|
14
docs/source/api/reference.rst
Normal file
14
docs/source/api/reference.rst
Normal 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
|
1
docs/source/api/rust_reference.inc
Normal file
1
docs/source/api/rust_reference.inc
Normal file
@ -0,0 +1 @@
|
||||
The Rust API has not been documented yet.
|
@ -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"]
|
||||
|
@ -34,6 +34,10 @@ Components:
|
||||
pipeline
|
||||
components
|
||||
|
||||
.. toctree::
|
||||
|
||||
api/reference
|
||||
|
||||
Load an existing tokenizer:
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
|
Reference in New Issue
Block a user