carpetmod112
carpetmod112 copied to clipboard
gnembon
Use readthedocs for documentation
I would like to propose using readthedocs and reStructured Text as a solution for documentation. The current google spreadsheets documentation is unwieldy, hard to contribute to, and lacks much of the information expected in a complete documentation.
By moving to RTD, we can make the following improvements and additions:
- Add textual instructions for installation
- Add a textual "gentle introduction" to carpet
- Provide a reference of Carpet commands
- Place documentation under version control (it can live under a
docs/directory alongside the code, and the user will be able to select the documentation version to view in RTD) - Allow people to submit PRs to contribute to the documentation as well.
If this sounds good to you, I will prepare a PR with an initial documentation.
sure - that would be great. I am not aware of the google spreadsheet docs. Making it part of the repo makes complete sense.
Is there a way to generate some of the documentation from Javadocs using readthedocs?
Also how rtd works. Is it free for open public repos? I tried to see how to set it up and the only thing I see on their page is payment options.
Yes, it should be free for public repos
On Thu, Oct 11, 2018, 13:21 gnembon [email protected] wrote:
Also how rtd works. Is it free for open public repos? I tried to see how to set it up and the only thing I see on their page is payment options.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/gnembon/carpetmod112/issues/28#issuecomment-429066095, or mute the thread https://github.com/notifications/unsubscribe-auth/ABeWip94bVtaIL-gECe-o3UstZK2bTfGks5uj4xEgaJpZM4V0A8M .