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

completing some doc references #20039

Merged
merged 6 commits into from Jan 26, 2015
Merged

Conversation

arnisoph
Copy link
Contributor

those files should be auto-generated, otherwise users won't find those Salt features!

@arnisoph
Copy link
Contributor Author

dirty shell script:

files=$(find ../../../../salt/runners -type f -name '*.py' -exec basename {} \;)

for f in ${files[@]}; do
  modname="${f%%.py}"
  fullmodname="salt.runners.${modname}"
  docfile="${fullmodname}.rst"

  if [[ "$f" == *__init__.py || \
        "$f" == index.rst || \
        -e "$docfile" ]]; then
    continue
  fi

  i=0
  head=''
  while [[ $i -lt ${#fullmodname} ]]; do head="${head}="; i=$((i + 1)); done
  echo "${head}\n${fullmodname}\n${head}\n\n.. automodule:: ${fullmodname}\n    :members:" > $docfile
done

@arnisoph
Copy link
Contributor Author

#19262 is related to that.

thatch45 added a commit that referenced this pull request Jan 26, 2015
@thatch45 thatch45 merged commit bfc6ead into saltstack:develop Jan 26, 2015
@thatch45
Copy link
Member

Wow, thanks @bechtoldt !

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.

None yet

2 participants