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
[RDY] Project documentation #302
Conversation
Nice. Can you write the prerequisites needed to run this? Maybe it should be added to CI ? |
@justinmk sorry for the late reply, I added the docs env to tox. I'll be writing the docs on the next days/weeks :) |
@justinmk this is how it would looks like on rtd http://stsewd-test-nvim-python-client.readthedocs.io/en/latest/index.html (just for testing, I'll delete the project once the PR is merged). |
docs/index.rst
Outdated
@@ -1,5 +1,5 @@ | |||
Neovim's Python Client | |||
====================== | |||
Neovims Python Client |
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.
I guess this must be Neovim
as well? (without s
)
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.
Right now I fixed it 😄
Please feel free to correct me any grammatical error or misspelling, since English isn't my native language. Also I'm following the rtd style guide for docs here. |
LGTM. I don't think we need 19 commits of granularity, I'll squash to 1 unless there are a couple changes you think need to be separated in the history. Is this still WIP or ready to go? What happens next? Do we need to register on RTD website (hope not), or will it pick up the |
docs/api/nvim.rst
Outdated
@@ -0,0 +1,7 @@ | |||
Neovim Class |
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.
shouldn't this be "Nvim Class"?
docs/conf.py
Outdated
|
||
# General information about the project. | ||
project = 'Neovim Python Client' | ||
copyright = '2018, Neovim' |
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.
probably should be 2014
Yeah, one commit is fine for me too (sorry, I do every little separate change a commit).
Yes, it is still WIP, just need to finish two or three sections.
Yes, someone with access to the repository must be registered on RTD (if not, you can't configure the webhook), then:
After that we can include the RTD badge on the readme file and probably. Sorry for the late reply, again. |
@justinmk I think we are ready to go now, please let me know any problem and I will try to fix it the faster that I can. Thank guys, I really appreciate all the work you do on Neovim. |
I signed up on RTD, and seem to be able to connect the project. Quite a bit of text in |
@justinmk Maybe this is the time to change the name of the library to pynvim? |
@bfredl Yeah, I was thinking the same, it's probably better to keep a simpler readme file and just linking from that to RTD. A PR after this one is merged is better (so we can include the rtd badge too!) |
tox.ini
Outdated
@@ -1,5 +1,7 @@ | |||
[tox] | |||
envlist = py{27,33,34,35,36}-{asyncio,pyuv},pypy | |||
envlist = | |||
py{27,33,34,35,36}-{asyncio,pyuv},pypy |
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.
py33 should be removed
docs/installation.rst
Outdated
Installation | ||
============ | ||
|
||
The Neovim Python client supports Python 2.7, and 3.3 or later. |
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.
3.4
LGTM, merged. Thanks for your work! |
http://pynvim.readthedocs.io/en/latest/ seems to work. However, Readthedocs at the same time claims that it did create a GitHub webhook, and that there is no working webhooks, so automatic updates are disabled. |
Good call. Could be interesting to do this for the vim docs .... |
@justinmk as project admin I think you have to go to the settings page of this repo and somehow accept the readthedocs hook, or you could give me the right to manage hooks for this repo :) |
The generated docs should be linked in the README.md (and any duplicate content should be removed). In the meantime I added http://pynvim.readthedocs.io/en/latest/ to the repo description. |
@stsewd It should be fixed now, I pushed commit and its seems the hook was triggered. |
Hi, this is an initial proposal to add the project documentation using sphinx, later we could host the docs on https://readthedocs.org/ so it gets updated on each commit.
This is an example of how it looks
Please let me know if you are agree with this, so I can keep with this PR :). Thanks for so awesome API!