Skip to content

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

Closed
pfctdayelise opened this issue Jul 26, 2015 · 11 comments
Closed

Change docs files from .txt to .rst #890

pfctdayelise opened this issue Jul 26, 2015 · 11 comments
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification

Comments

@pfctdayelise
Copy link
Contributor

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

@pfctdayelise pfctdayelise added type: docs documentation improvement, missing or needing clarification good first issue easy issue that is friendly to new contributor labels Jul 26, 2015
@oleksmarkh
Copy link
Contributor

Hi and thanks for that amazing talk on EP15 :)

I would like to help with doc/en.

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?

@pfctdayelise
Copy link
Contributor Author

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.

@Akasurde
Copy link
Contributor

Akasurde commented Aug 3, 2015

@oleksmarkh , @pfctdayelise - I would love to work on this.

@oleksmarkh
Copy link
Contributor

@pfctdayelise , sorry for not creating a PR yet. Planning to finally do it till 04.08 evening.
@Akasurde , we could even do it together, if you want - for instance, I can help with testing all those files built. If not, just ignore me and post your PR straight away :)

@Akasurde
Copy link
Contributor

Akasurde commented Aug 3, 2015

@pfctdayelise Let us do it together then

@pfctdayelise
Copy link
Contributor Author

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

@Akasurde
Copy link
Contributor

Akasurde commented Aug 4, 2015

@oleksmarkh can you please check PR #912 ?

@oleksmarkh
Copy link
Contributor

@Akasurde , it fails. As it says, continuous-integration/appveyor fails because your branch can't be merged. Is it up to date?

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.

@Akasurde
Copy link
Contributor

Akasurde commented Aug 4, 2015

I have made some changes in PR #912 , build is passing for me.

@oleksmarkh
Copy link
Contributor

@Akasurde , I've tested #915, looks good. Thanks for taking it :)

nicoddemus added a commit that referenced this issue Aug 7, 2015
@nicoddemus
Copy link
Member

Just merged it, thanks everyone! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

No branches or pull requests

4 participants