Consider adding http://www.sphinx-doc.org/en/master/ - Getting started - Setup for dev - Model - fedmsg configuration - Authentication
Metadata Update from @algogator: - Issue assigned to algogator
Metadata Update from @jonatoni: - Issue priority set to: next week (was: awaiting triage)
Sphinx would be a good choice since it is standard for Python projects. I've played with Sphinx a good bit, so if you have any questions about it, you're welcome to ping me.
If you have time, you can also explore Pagure's ReadTheDocs integration as an option to host any Sphinx docs you write.
<img alt="Enable ReadTheDocs support on a Pagure repo" src="/fedora-commops/fedora-happiness-packets/issue/raw/files/b0d9be30bc0d1acb43ffbed19ce38a8ae33e4fcfc998a0e214ce312ca9c22a45-Screenshot_2018-07-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure.png" />
Metadata Update from @algogator: - Issue tagged with: GCI
Metadata Update from @jflory7: - Issue tagged with: PASSED, difficulty - medium, needs info, type - docs
Metadata Update from @jflory7: - Assignee reset
Metadata Update from @jflory7: - Issue assigned to echoduck - Issue set to the milestone: Summer Coding 2019: community bonding
Metadata Update from @jflory7: - Issue untagged with: needs info
@echoduck submitted #65 which implements Sphinx documentation. I pushed commit ab39fc5 to refactor a few things to publish on readthedocs.org. I did this, and also pushed commit 42422e0 to add a link to the docs in the README.
Check out the new docs here:
https://fedora-happiness-packets.readthedocs.io/
Thanks for working on this, @echoduck! Closing as complete. :clapper:
Metadata Update from @jflory7: - Issue close_status updated to: complete - Issue status updated to: Closed (was: Open)
Login to comment on this ticket.