-
-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Spinx-based documentation #194
Conversation
Also I ended up adding sphinx and the theme to the requirments.ini - I don't think that's the right spot for them but I'm not sure where they should go. |
Also the contributing page - feels like a lot of projects have that but I am not sure what to put there. Do you have copy you'd like for that or should I ax it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting this started. I'm going to update a bunch of stuff before merging this. Started with some review comments below, will be pushing to the PR. Please do make me an admin on Read the Docs.
…ecessary options, latexpdf config, intersphinx use 'stable' django
Okay I’ve updated everything I could think of, rewritten the docs to make use of Sphinx features, and added a tips section covering CSRF. Please make me the owner on RtD so I can merge this. |
What's your RtD username? github id 404s :( |
It's the same, with caps https://readthedocs.org/profiles/AdamChainz/ |
I guess it's case sensitive then - added |
Brilliant! I'm in, thanks. |
Turns out to correctly set up the RtD project with the right repo and a working webhook, I needed to delete and recreate it. 🤷♂️ Thanks for doing the initial setup here. Expanded docs are sure to help folks get started with htmx more easily. |
Bleh annoying - learning for me, next time I'll use a testing slug |
First pass of documentation using sphinx/furo
I have never done a documentation system before so I have no idea if there's a lot of easy improvements I should be doing - if you point them out to me I'm happy to improve!
I need to flush out the tips section - I will do so this week, I just wanted to get the structure in place.
I opened a read the docs instance: https://django-htmx.readthedocs.io/en/latest/ - I didn't realize it would yank the identifier, so let me know if the there's a way to transfer to you or if I should delete the instance.
I stole the precommit and spell check from debug toolbar. Let me know if there's other checks that would be helpful.