forwarding this as good doc efforts should be shared! ---------- Forwarded message --------- From: Daniele <[email protected]> Date: Tue, Apr 23, 2019, 4:22 AM Subject: [Yelp/py_zipkin] Better documentation - generate readthedocs compatible docs (#127) To: Yelp/py_zipkin <[email protected]> Cc: Subscribed <[email protected]>
@jstrfd <https://github.com/jstrfd> Sorry, I've been very busy the last few days. This is the in progress branch I had for adding better docs. It doesn't help you much yet as I haven't written many code samples yet, but I'll try to do it this evening or tomorrow ------------------------------ You can view, comment on, or merge this pull request online at: https://github.com/Yelp/py_zipkin/pull/127 Commit Summary - Add docs File Changes - *M* CHANGELOG.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-0> (3) - *M* Makefile <https://github.com/Yelp/py_zipkin/pull/127/files#diff-1> (8) - *M* README.md <https://github.com/Yelp/py_zipkin/pull/127/files#diff-2> (248) - *A* docs/source/CHANGELOG.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-3> (1) - *A* docs/source/DEPRECATIONS.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-4> (1) - *A* docs/source/conf.py <https://github.com/Yelp/py_zipkin/pull/127/files#diff-5> (180) - *A* docs/source/encoding.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-6> (48) - *A* docs/source/index.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-7> (31) - *A* docs/source/multithreading.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-8> (4) - *A* docs/source/transport.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-9> (99) - *A* docs/source/usage.rst <https://github.com/Yelp/py_zipkin/pull/127/files#diff-10> (108) - *M* py_zipkin/encoding/__init__.py <https://github.com/Yelp/py_zipkin/pull/127/files#diff-11> (16) - *M* py_zipkin/transport.py <https://github.com/Yelp/py_zipkin/pull/127/files#diff-12> (4) - *M* py_zipkin/zipkin.py <https://github.com/Yelp/py_zipkin/pull/127/files#diff-13> (83) - *M* tox.ini <https://github.com/Yelp/py_zipkin/pull/127/files#diff-14> (8) Patch Links: - https://github.com/Yelp/py_zipkin/pull/127.patch - https://github.com/Yelp/py_zipkin/pull/127.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/Yelp/py_zipkin/pull/127>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAPVV5FI3RJNVYNV2XKH3DPRYM7ZANCNFSM4HHSMKGA> .
