Generate docs for generic easyblocks (REVIEW) #1317
Conversation
…sybuild-framework into generic-easyblock-docs-issue636
|
Automatic reply from Jenkins: Can I test this? |
|
Jenkins: ok to test |
| lines.append(param) | ||
|
|
||
|
|
||
| if classname + '.eb' in os.listdir(os.path.join(os.path.dirname(__file__), 'doc_examples')): |
There was a problem hiding this comment.
these need to come from somewhere else, i.e. a location specified as an argument to doc_easyblock (which may need another name, although I can't think of one in 1-2-3)
also, don't include example .eb files here; at best, you can include some in the tests (next to the test easyconfigs we have already), so you can add a unit test for this code
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
…sybuild-framework into generic-easyblock-docs-issue636
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
|
||
| FORMAT_RST = 'rst' | ||
| FORMAT_TXT = 'txt' | ||
|
|
||
| def det_col_width(entries, title): |
There was a problem hiding this comment.
keep two blank lines between imports, constants, and top-level functions (so add one above here)
| f = eb_class.__dict__[func] | ||
| elif func in eb_class.__bases__[0].__dict__: | ||
| f = eb_class.__bases__[0].__dict__[func] | ||
| inh = ' (inherited)' |
There was a problem hiding this comment.
hmm, not sure about this, my preference would be to not included these inherited methods and only mention the ones custom to the easyblock being documented in this section
|
@Caylo: also include a test for |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
…sybuild-framework into generic-easyblock-docs-issue636 Conflicts: easybuild/tools/docs.py
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
| '=' * len(title), | ||
| title, | ||
| '=' * len(title), | ||
| '', |
There was a problem hiding this comment.
insert a line that makes it clear that this page is auto-generated, something like:
'',
'*(this page was generated automatically using* ``easybuild.tools.docs.gen_easyblocks_overview_rst()`` *)*',
'',
boegel
changed the title
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Refer to this link for build results (access rights to CI server needed): This pull request is now ready for review/testing. Please try and find someone who can tackle this; contact @boegel if you're not sure what to do. |
|
Going in, thanks @Caylo! |
Generate docs for generic easyblocks (REVIEW)
Fixes easybuilders/easybuild-easyblocks#636