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 Sphinx based documentation #40

Merged
merged 3 commits into from May 17, 2019
Merged

Add Sphinx based documentation #40

merged 3 commits into from May 17, 2019

Conversation

codingjoe
Copy link
Contributor

@codingjoe codingjoe commented May 16, 2019

fixes #39

@Findus23
Copy link
Owner

The changes look good, but when I run python setup.py build_sphinx, I get an empty api_docs.html page.
Do I need to run anything else in addition?

@codingjoe
Copy link
Contributor Author

@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 :)

Copy link
Owner

@Findus23 Findus23 left a 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/

pylanguagetool/api.py Outdated Show resolved Hide resolved
pylanguagetool/__init__.py Outdated Show resolved Hide resolved
@codingjoe
Copy link
Contributor Author

codingjoe commented May 16, 2019

Hey @Findus23, I though I was going a bit over board with the personal word list, but I am glad you like it.
I am currently on the run, but I'll try to finish this asap. I also need to do another sorrow review myself.

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 :)

@Findus23
Copy link
Owner

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.

@codingjoe
Copy link
Contributor Author

@Findus23 I edited the last two commits to accommodate the changes we discussed. Let me know if you want me to change anything else.

@Findus23 Findus23 merged commit 86c5713 into Findus23:master May 17, 2019
@Findus23
Copy link
Owner

Thanks again for your help, I'll merge it now.

@Findus23
Copy link
Owner

And the gitlab CI also succeeded: https://git.lw1.at/open-source/pylanguagetool/-/jobs/925

@codingjoe codingjoe deleted the docs branch May 17, 2019 15:59
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.

Add API documentation
2 participants