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

Impove document #840

Closed
wannaphong opened this issue Sep 23, 2023 · 3 comments
Closed

Impove document #840

wannaphong opened this issue Sep 23, 2023 · 3 comments
Labels
documentation improve documentation and test cases Hacktoberfest for Hacktoberfest event
Milestone

Comments

@wannaphong
Copy link
Member

You can help me impove PyThaiNLP's document.

The PyThaiNLP's documentation is in https://github.com/PyThaiNLP/pythainlp/tree/dev/docs. It's use Sphinx to build the document.

The build tools can install by

pip install boto smart_open sphinx sphinx-rtd-theme

and build by

cd docs
make html

(Don't forget install make tools)

For API Docs:

You can edit by source code in PyThaiNLP. It's use reStructuredText for writing API docs.

@wannaphong wannaphong added documentation improve documentation and test cases Hacktoberfest for Hacktoberfest event labels Sep 23, 2023
@wannaphong
Copy link
Member Author

You can help me improve tutorials. see PyThaiNLP/tutorials#22

@Saharshjain78
Copy link
Contributor

Hey, I am interested in improving the documents, can you describe more about the issue?

@wannaphong
Copy link
Member Author

Hey, I am interested in improving the documents, can you describe more about the issue?

Some examples are missing, bad grammar, and missing necessary details.

Example: https://pythainlp.github.io/dev-docs/api/generate.html#pythainlp.generate.wangchanglm.WangChanGLM is missing necessary details about model and example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation improve documentation and test cases Hacktoberfest for Hacktoberfest event
Projects
Status: Done
Development

No branches or pull requests

3 participants