nils-braun / b2luigi

Task scheduling and batch running for basf2 jobs made simple
GNU General Public License v3.0
17 stars 11 forks source link

Some sphinx documentation formatting fixes #66

Closed meliache closed 3 years ago

meliache commented 3 years ago

I worked on removing some of the sphinx warnings that I mention in issue #64. Most importantly, the example for get_input_file_names_from_dict() by @welschma was not rendered as a code block.

I haven't yet managed to remove all warnings, one type of warning still remains:

/home/michael/basf2/externals/v01-09-01/Linux_x86_64/common/lib/python3.6/site-packages/b2luigi/basf2_helper/data.py:docstring of b2luigi.basf2_helper.data.CdstDataTask.output:13: WARNING: undefined label: task.output (if the link has no caption the label must precede a section header)

And the same for some other tasks with the output() method that are automatically included. But I couldn't come up with a quick fix and the docs for the CdstDataTask etc. look nice despite the warning, so I think I should just merge what I have so far and get on with more important issues.

Old Fixed
grafik grafik