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 Sphinx based documentation #40
Conversation
The changes look good, but when I run |
@Findus23 I am not done yet. The page is empty because there is no documentation. I am writing it right now. Wait for my next commit :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking really good!
I like the idea of using pylanguagetool as an automated test in CI. I was afraid that it would show too many false positives, but with the whitelist feature it should be possible.
If you are finished, I would merge this. And so that you work won't stay unnoticed, I'll also put the docs online at https://pylanguagetool.lw1.at/
Hey @Findus23, I though I was going a bit over board with the personal word list, but I am glad you like it. Regarding publishing the docs, I'd recommend using readthedocs.io, since this then biggest Python open source platform. Plus it builds directly from GitHub, which saves trouble. But you do as you do :) |
No hurry, finish it whenever you find time. While I see that readthedocs are doing a really great job, I prefer hosting things myself and there aren't that frequent updates that setting up automation is necessarly. |
@Findus23 I edited the last two commits to accommodate the changes we discussed. Let me know if you want me to change anything else. |
Thanks again for your help, I'll merge it now. |
And the gitlab CI also succeeded: https://git.lw1.at/open-source/pylanguagetool/-/jobs/925 |
fixes #39