search

zopefoundation / zope.testing

Other
4 stars 13 forks source link

Move documentation to RTD #20

Closed icemac closed 3 years ago

icemac commented 6 years ago

Currently the documentation is only in the repository. It is not well readable because the files have a .txt extension instead of .rst.

icemac commented 3 years ago

There is already https://zopetesting.readthedocs.io/en/latest/ but it only contains an overview of the modules provided here. Maybe the doctests should also be rendered over there.

jamadden commented 3 years ago

The URL zopetesting.readthedocs.io is owned by @tseaver but is in need of maintenance. For example, there is no webhook installed here to updated the docs, and they haven't been built in 3 years. Perhaps @tseaver would be willing to add some co-maintainers?

tseaver commented 3 years ago

I've lost any idea about how the docs should be built here. There is no docs/ directory, and the rtd.txt file looks like it is just a set of prereqs. The latest and stable builds on RTD are failing.

I would be happy to add one or more owners who are motivated to fix the docs build.

icemac commented 3 years ago

@tseaver Could you please add me (icemac) and @jamadden (jamadden@gmail.com) as co-maintainers at https://readthedocs.org/projects/zopetesting/?

tseaver commented 3 years ago

Screenshot from 2021-09-24 10-16-53

jamadden commented 3 years ago

Thanks @tseaver! There are a few other zopefoundation projects on RTD that are only maintained by you; when you have the time and motivation if you could add us as maintainers to those it would be appreciated!

In the meantime, I've established the webhook for this project, but it's going to take some TLC to get the docs building again. I'm happy to work on that today.

tseaver commented 3 years ago

@jamadden, @icemac I think I've added you both to all the ZF projects for which I was the "last maintainer standing" on RTD.

jamadden commented 3 years ago

Thanks @tseaver!