search

tetra-framework / tetra

Tetra - A full stack component framework for Django using Alpine.js
https://www.tetraframework.com
MIT License
540 stars 14 forks source link

Sphinx documentation #34

Closed nerdoc closed 1 year ago

nerdoc commented 1 year ago

Hi Sam, I'v created a"sphinx" branch in my repo (I already included all the typo fix commits which mainly were in the docs, you could forget that PR) Please have a look at https://tetraframework.readthedocs.io/en/latest/ I was so keen "releasing that into the wild" - if you don't like that I'll deactivate it again.

It contains more or less 1:1 copies of your .md docs, I tried to mimic the current docs as close as possible. There are a few errors at coree-reference links which should be fixed, but this could be done after the transfer too.

ATM the docs page uses the "sphinx" branch of my fork. I could change that with one last commit, and you could pull the branch into your repo - meanwhile I transfer the project on readthedocs to your account.

Please tell me what you think. It's not perfect yet, and should be better structured (example/workthrough in own page, etc), but it can be searched (which works great).

I think all the commits with you as auhor was because of my rebase when I merget the "typo" branch in. I think I'll do that again using merge, not rebase. Or completely leave it out.

I just want to know what you think about the whole page - then I can so it again and clean it up form the commits Cheers, Christian

nerdoc commented 1 year ago

ok, forget this PR, I'll make a clean one.