search

galaxyproject / ephemeris

Library for managing Galaxy plugins - tools, index data, and workflows.
https://ephemeris.readthedocs.org/
Other
27 stars 38 forks source link

Setup Sphinx docs so this can be published to RTD. #44

Closed jmchilton closed 7 years ago

jmchilton commented 7 years ago

This is based on the Pulsar/Planemo template so this fills in some initial content - install directions, code of conduct, contributing description, docs for process for publishing to PyPI, and establishing a governance policy (@bgruening as "Benevolent Dictator for Now" with a small "committer" group (@afgane, @drosofff, @jmchilton, @bgruening, @mvdbeek) - everyone who has added more than 100 lines of code).

I think another obvious win for documentation would be dump the --help for all the commands to the docs. I do this with Planemo here (http://planemo.readthedocs.io/en/latest/commands.html) and it works well I think. I don't know if the lack of Click here would make that more difficult now.

xref #1

hexylena commented 7 years ago

I'm happy to write a short tutorial on using the sleep command / example uses / etc. Have been waiting for this to be solved :) could really benefit from some how to / cookbook type things.

rhpvorderman commented 7 years ago

If this request was pulled I would gladly contribute with documentation on the usage of shed-install and run-data-managers.

jmchilton commented 7 years ago

Thanks for the offers @erasche and @rhpvorderman - sorry for not being better about documenting these things from the get go. It is hard to know what ideas are going to catch and what ideas are going to fail - so I tend not to document things well unless I know it will be read. I will try to configure RTDs now.