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

Generate and publish API documentation #41

Open
hickford opened this issue Apr 16, 2021 · 2 comments
Open

Generate and publish API documentation #41

hickford opened this issue Apr 16, 2021 · 2 comments

Comments

@hickford
Copy link
Contributor

hickford commented Apr 16, 2021

Great library! It was comprehensive docstrings, so it would be helpful to generate API documentation with Sphinx and publish on the Read the Docs. Published documentation is easier to browse, search and link.

https://www.sphinx-doc.org/en/master/
https://readthedocs.org/

Many many other Python projects use Sphinx and Read the Docs, eg. https://docs.python-requests.org/en/master/

@hickford
Copy link
Contributor Author

hickford commented Apr 16, 2021

The pull requests adds code to generate documentation. After merging, the next step is to make a free account at Read the Docs and point at the repo https://docs.readthedocs.io/en/stable/intro/import-guide.html

I see that https://github.com/LuminosoInsight/python-ftfy is already on Read the Docs https://ftfy.readthedocs.io/en/latest/

@hickford hickford changed the title Generate API documentation with Sphinx and publish on Read the Docs Generate and publish API documentation Apr 16, 2021
@hickford
Copy link
Contributor Author

hickford commented Apr 20, 2021

For temporary use: published docs from my personal fork https://langcodes-hickford.readthedocs.io/en/sphinx/source/langcodes.html

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

No branches or pull requests

1 participant