Generate docs for generic easyblocks (REVIEW) #1317

Caylo · 2015-07-08T08:02:52Z

Fixes easybuilders/easybuild-easyblocks#636

…sybuild-framework into generic-easyblock-docs-issue636

hpcugentbot · 2015-07-08T08:02:54Z

Automatic reply from Jenkins: Can I test this?

boegel · 2015-07-08T08:11:08Z

Jenkins: ok to test

boegel · 2015-07-08T08:19:41Z

easybuild/tools/docs.py

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

hpcugentbot · 2015-07-08T08:45:46Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1857/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1857/console for more details).

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.

something went wrong there

hpcugentbot · 2015-07-08T09:26:32Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1858/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1858/console for more details).

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.

hpcugentbot · 2015-07-08T10:00:59Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1859/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1859/console for more details).

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

hpcugentbot · 2015-07-08T14:03:52Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1861/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1861/console for more details).

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.

boegel · 2015-07-08T14:45:37Z

easybuild/tools/docs.py

keep two blank lines between imports, constants, and top-level functions (so add one above here)

boegel · 2015-07-13T08:48:41Z

easybuild/tools/docs.py

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

boegel · 2015-07-13T08:55:09Z

@Caylo: also include a test for gen_easyblocks_overview_rst? There are test easyblocks/easyconfigs included in test/framework/sandbox and test/framework/easyconfigs that you can use.

hpcugentbot · 2015-07-13T08:59:43Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1890/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1890/console for more details).

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.

hpcugentbot · 2015-07-13T09:38:35Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1891/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1891/console for more details).

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.

hpcugentbot · 2015-07-13T10:17:03Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1893/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1893/console for more details).

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.

hpcugentbot · 2015-07-13T10:55:18Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1894/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1894/console for more details).

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.

hpcugentbot · 2015-07-13T11:33:34Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1895/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1895/console for more details).

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.

hpcugentbot · 2015-07-13T12:10:41Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1896/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1896/console for more details).

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

hpcugentbot · 2015-07-14T15:28:00Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1908/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1908/console for more details).

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.

boegel · 2015-07-15T14:12:45Z

easybuild/tools/docs.py

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()`` *)*', '',

hpcugentbot · 2015-07-15T16:02:55Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1916/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1916/console for more details).

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.

hpcugentbot · 2015-07-15T16:44:03Z

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1917/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1917/console for more details).

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.

boegel · 2015-07-15T17:14:37Z

Going in, thanks @Caylo!

Generate docs for generic easyblocks (REVIEW)

Caylo added 7 commits July 6, 2015 17:04

Begin script for generic easyblock documentation

0dceb5d

Generic easyblock docs, continued

8fbc168

python star operator is gr8

7cfc6a2

Separate function for making rst tables

31587c9

Merge branch 'generic-easyblock-docs-issue636' of github.com:Caylo/ea…

94425d2

…sybuild-framework into generic-easyblock-docs-issue636

Also use mk_rst_table in avail_easyconfig_params

34c2853

added table of contents

e96df9a

boegel reviewed Jul 8, 2015
View reviewed changes

Caylo added 2 commits July 8, 2015 10:52

Fixed some remarks

05bd752

Delete :q

c657025

something went wrong there

Caylo added 3 commits July 8, 2015 15:11

added custom step functions to doc

cc8da01

remove examples from framework

09a9742

Merge branch 'generic-easyblock-docs-issue636' of github.com:Caylo/ea…

60f70a2

…sybuild-framework into generic-easyblock-docs-issue636

Caylo added 3 commits July 8, 2015 16:25

added internal references for parent classes

0299605

added mark for inherited functions

5baa702

added page title

1e35b42

boegel added this to the v2.2 milestone Jul 8, 2015

boegel reviewed Jul 8, 2015
View reviewed changes

easybuild/tools/docs.py Outdated

Copy link

Member

boegel Jul 8, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep two blank lines between imports, constants, and top-level functions (so add one above here)

boegel reviewed Jul 13, 2015
View reviewed changes

Caylo added 2 commits July 13, 2015 11:15

Fixed remarks

9204337

sort easyblocks

8a4ec13

Caylo added 2 commits July 13, 2015 11:47

remove debug print

a48c80b

forgot a ':'

b48bf8c

boegel modified the milestones: v2.3, v2.2 Jul 14, 2015

Caylo added 2 commits July 14, 2015 16:48

rst documentation for generic easyblocks unit test

307ae84

Merge branch 'generic-easyblock-docs-issue636' of github.com:Caylo/ea…

a75787b

…sybuild-framework into generic-easyblock-docs-issue636 Conflicts: easybuild/tools/docs.py

boegel reviewed Jul 15, 2015
View reviewed changes

Caylo added 2 commits July 15, 2015 16:40

table of contents as list

cb4bd0f

remark above title

3c394ae

boegel changed the title ~~Generate docs for generic easyblocks (WIP)~~ Generate docs for generic easyblocks (REVIEW) Jul 15, 2015

boegel added a commit that referenced this pull request Jul 15, 2015

Merge pull request #1317 from Caylo/generic-easyblock-docs-issue636

87e0f7c

Generate docs for generic easyblocks (REVIEW)

boegel merged commit 87e0f7c into easybuilders:develop Jul 15, 2015

Generate docs for generic easyblocks (REVIEW) #1317

Generate docs for generic easyblocks (REVIEW) #1317

Uh oh!

Conversation

Caylo commented Jul 8, 2015

Uh oh!

hpcugentbot commented Jul 8, 2015

Uh oh!

boegel commented Jul 8, 2015

Uh oh!

boegel Jul 8, 2015

Choose a reason for hiding this comment

Uh oh!

hpcugentbot commented Jul 8, 2015

Uh oh!

hpcugentbot commented Jul 8, 2015

Uh oh!

hpcugentbot commented Jul 8, 2015

Uh oh!

hpcugentbot commented Jul 8, 2015

Uh oh!

boegel Jul 8, 2015

Choose a reason for hiding this comment

Uh oh!

boegel Jul 13, 2015

Choose a reason for hiding this comment

Uh oh!

boegel commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 13, 2015

Uh oh!

hpcugentbot commented Jul 14, 2015

Uh oh!

boegel Jul 15, 2015

Choose a reason for hiding this comment

Uh oh!

hpcugentbot commented Jul 15, 2015

Uh oh!

hpcugentbot commented Jul 15, 2015

Uh oh!

boegel commented Jul 15, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants