Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add python api document #102

Merged

Conversation

mh-northlander
Copy link
Collaborator

#98

Generate doc:

  • install sudachi.rs python binding: pip install setuptools-rust; python setup.py develop
  • install sphinx and theme: pip install sphinx sphinx-rtd-theme
  • run make html in docs directory
    • html will be generated under docs/build/html

@eiennohito
Copy link
Collaborator

eiennohito commented Oct 15, 2021

Please don't add automatically-generated things to git.

Also, does the build generate .pyi files like https://github.com/huggingface/tokenizers/blob/master/bindings/python/py_src/tokenizers/__init__.pyi?

@mh-northlander
Copy link
Collaborator Author

.rst files are contents files to auto-generate documents with sphinx. We can write additional explanations to them.

Also, does the build generate .pyi files like https://github.com/huggingface/tokenizers/blob/master/bindings/python/py_src/tokenizers/__init__.pyi?

Those pyi files are generated by https://github.com/huggingface/tokenizers/blob/0fe9214f44f4e117a85e3880c20631cc70298d86/bindings/python/stub.py.

@mh-northlander mh-northlander marked this pull request as ready for review October 18, 2021 10:44
@mh-northlander mh-northlander merged commit cb154be into WorksApplications:develop Oct 19, 2021
@mh-northlander mh-northlander deleted the python-api-doc branch October 19, 2021 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants