-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Change docs files from .txt to .rst #890
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
Comments
Hi and thanks for that amazing talk on EP15 :) I would like to help with Looks like it's (mainly) quite a manual work, though content of these files is already kind of reStructured. So is it about renaming extensions of all the files + minor corrections + proof reading? Could it mean also testing the docs (if all examples are still valid)? Any priorities here? Should it be one giant complete PR if not? |
Hi @markhovskiy, great! :) I think it only needs to rename the files (git mv), as the contents are already RST as you noticed. Then there will be some scripts which are looking for .txt files and should be changed to look for .rst. The code examples inside the docs should be fine as they don't need to be changed. Step 8 in https://github.com/pytest-dev/pytest/blob/master/HOWTORELEASE.rst has the info about how to build the docs. So build them locally and browse around a bit to make sure things still seem to be working correctly, is my suggestion. |
@oleksmarkh , @pfctdayelise - I would love to work on this. |
@pfctdayelise , sorry for not creating a PR yet. Planning to finally do it till 04.08 evening. |
@pfctdayelise Let us do it together then |
@Akasurde I think you meant to address @oleksmarkh, since you two are keen I won't get involved, but I will review it when there is a PR :) |
@oleksmarkh can you please check PR #912 ? |
@Akasurde , it fails. As it says, Anyway, looks like either/both /Makefile and/or /doc/en/Makefile aren't updated. I'm not yet sure if those are required to fix docs generation. |
I have made some changes in PR #912 , build is passing for me. |
Just merged it, thanks everyone! 😄 |
This will mean that the contents are previewed on Github. It's much nicer to look at and also makes editing in the Github web interface quite easy. We have this already for CONTRIBUTING, README and HOWTORELEASE at the top level but in the docs/en dir. See e.g. https://github.com/pytest-dev/pytest/blob/master/CONTRIBUTING.rst
The text was updated successfully, but these errors were encountered: