Utilizing Read the Docs for Documentation?

[ac-arcana]

Would utilizing something like Read the Docs to create documentation for Cogito make it more accessible?

Read the Docs is utilized for Godot itself : https://readthedocs.org/projects/godot/

It is free to use for open source projects (but it contains ads)

https://about.readthedocs.com/features/

It automatically builds for every version, updates with new changes, can translate into several languages, and can be downloaded for offline use. The documentation lives with the code on github.

I'd love to know what everyone's thoughts are on this. I would be willing to try to set this up for the repo if there interest.

[Phazorknight]

Looks very feature-rich for sure, but might be a bit overkill.
For once, we don't even have proper documentation yet 😅 .

I'm happy with keeping it with the github documentation that I have started, but if you're keen to switch it to Read The Docs, then I'm fine with that as well and will add/maintain it as best as I can.

[ac-arcana]

We now have our first successful build of Read the Docs.

The online version can be found here: https://cogito.readthedocs.io/en/latest/
The repo also has a local copy at docs/_build/html/index.html

I don't think the local copy will be updated unless I run builds of it on my end. It was helpful to see formatting changes immediately, but I think its less important now that the online build is working.
@Phazorknight if you want the local copy out of the build to reduce bloat let me know and I'll remove it and do a commit.

[ac-arcana]

Also I'm open to feedback - I do think it looks pretty slick right now, though.
I'll add more to it myself too.

It is built on sphinx and ReStructuredText.
Sphinx: https://www.sphinx-doc.org/en/master/
ReStructuredText: https://docutils.sourceforge.io/rst.html

Editing is done on the files with the extension .rst . Although it is different than the markup used in github's md files, it has a lot in common with it.

I found this quick ref resource quite helpful: https://docutils.sourceforge.io/docs/user/rst/quickref.html

We can add as many pages and as deep a tree structure as we like. We can add folders with multiple pages inside them to break things up, but I opted for larger pages with full content for the first build.

I love that it is searchable, too!

[Phazorknight]

Amazing, thank you so much for setting this up! And yeah, it looks very neat.

I probably won't have a chance to add much to it over the weekend, but will try to get it more filled and updated on monday.

[Phazorknight]

Closing this as this has been implemented. Thanks so much @ac-arcana !