search

SMART-Lab / smartdispatch

An easy to use job launcher for supercomputers with PBS compatible job manager.
Do What The F*ck You Want To Public License
34 stars 18 forks source link

Readthedocs documentation #160

Open ddtm opened 7 years ago

ddtm commented 7 years ago

Addresses #113

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 94.532% when pulling e8a7d0ab46e8aa1412b0f99891da139857d83cdf on ddtm:readthedocs into c94f08e828d6deec453c054fd340e694ec0e0b9a on SMART-Lab:master.

bouthilx commented 7 years ago

@ddtm Did you have any problem installing sphinxcontrib-autoprogram? I installed it (version 0.1.3) and I got an error when compiling the doc because of a p2-p3 incompatibilty of textwrap. 

Exception occurred:
  File "/home/bouthilx/.virtualenvs/smartdispatch/local/lib/python2.7/site-packages/sphinxcontrib/autoprogram.py", line 223, in make_rst
    yield textwrap.indent(usage, '    ')
AttributeError: 'module' object has no attribute 'indent'
The full traceback has been saved in /tmp/sphinx-err-lVwo2K.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 1

I had to pull a fresh version from bitbucket and reinstall it to be able to compile the doc.

bouthilx commented 7 years ago

@ddtm I know you currently are outside for an internship, but would it be possible for you the make the small fix for the PR?

bouthilx commented 7 years ago

@mgermain We could use sphinx-argparse instead of sphinxcontrib-autoprogram. See a comparison here.

mgermain commented 7 years ago

If it does everything that sphinxcontrib-autoprogram does and is better supported I have no objection. @ddtm https://github.com/ddtm might.

On Tue, Aug 29, 2017 at 2:02 PM, Xavier Bouthillier < notifications@github.com> wrote:

@mgermain https://github.com/mgermain We could use sphinx-argparse http://sphinx-argparse.readthedocs.io/en/latest/sample.html instead of sphinxcontrib-autoprogram.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/SMART-Lab/smartdispatch/pull/160#issuecomment-325745778, or mute the thread https://github.com/notifications/unsubscribe-auth/ABBvm_hWHZzWwM_5RFvpKc_0gGpsqB4wks5sdFJSgaJpZM4MRbV0 .