search

Drachenfrucht1 / godotcord

A Discord Game SDK integration for Godot
https://drachenfrucht1.github.io/godotcord
MIT License
53 stars 5 forks source link

Use ReadTheDocs to host documentation. #71

Closed sairam4123 closed 3 years ago

sairam4123 commented 3 years ago

Hey, why not use ReadTheDocs, it's what Godot uses, and I'd recommend using it. Currently, I know you're using GitHub Pages, but it's better to use ReadTheDocs instead.

jordi-star commented 3 years ago

What makes ReadTheDocs better? It's more complex to set up really, GitHub pages is nice and simple since it's hosted directly with the repo for ease of access.

sairam4123 commented 3 years ago

Well, we're currently writing docs seperately from XML docs right? We could just parse the XML Docs and post it on ReadTheDocs.

Drachenfrucht1 commented 3 years ago

I agree with jordi. Using ReadTheDocs only adds unnecessary to this small scale project.

I am also currently working on parsing the xml docs into markdown and updating the gh-pages branch automatically on the xml-docs branch. I just want to have a decent amount of the classes documented before merging.

sairam4123 commented 3 years ago

Hmm, that's good indeed.