Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to generate generic easyblock documentation #132

Merged
merged 12 commits into from
Jun 29, 2016

Conversation

Caylo
Copy link
Contributor

@Caylo Caylo commented Jul 10, 2015

Needs easybuilders/easybuild-framework#1317

@boegel:

  • Example files need to be provided
  • constants COMMON_PARAMS and DOC_FUNCTIONS need to be completed

@@ -0,0 +1,591 @@
==============================Overview of generic easyblocks==============================.. contents:: :depth: 2.. _BinariesTarball:
Copy link
Member

Choose a reason for hiding this comment

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

the contents bit should be on a new line?

@@ -0,0 +1,781 @@
==============================
Copy link
Member

Choose a reason for hiding this comment

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

include a clear comment on top that this is auto-generated (let the script do that)

@Caylo Caylo changed the title Script to generate generic easyblock documentation Script to generate generic easyblock documentation (WIP) Jul 15, 2015
Caylo and others added 3 commits June 29, 2016 13:12
minor tweaks to script to generate docs for generic easyblocks
update generated docs for generic easyblocks
@boegel boegel changed the title Script to generate generic easyblock documentation (WIP) Script to generate generic easyblock documentation Jun 29, 2016
@boegel
Copy link
Member

boegel commented Jun 29, 2016

this can be extended later with more examples and tweaking COMMON_PARAMS and DOC_FUNCTIONS, I'll merge this as-is

@boegel boegel merged commit 9f42fdd into easybuilders:develop Jun 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants