gen_doc.sh

###############################################################################
## generate documentation #####################################################
#                                                                             #
# The following operations are performed:                                     #
# :o update 'contents block' documentation at the top of each component       #
# :o update package group documentation .md files                             #
#                                                                             #
###############################################################################

set -e # exit immediately on error

# cd to the dir of this script, so we can run scripts in the same dir
cd "$(dirname "$0")"

###############################################################################
# update 'contents block' documentation at the top of each component
###############################################################################

python meta/docgen/updatemodcontents.py \
    --force-insert \
    `find py/ meta/docgen meta/autofix -iname '*.py' | grep -v __t | grep -v __it`
printf "."
printf " "

###############################################################################
# update package group documentation .md files
###############################################################################

for dir in $(find py/ -mindepth 1 -maxdepth 1 -type d); do
    group=$(basename "${dir}")
    mdfile="${dir}/README.md"
    echo "# ${group}" > ${mdfile}
    python meta/docgen/genmoddoc.py \
        --docfile - \
        `find ${dir} -iname '*.py' | grep -v __t | grep -v __it`  \
        >> ${mdfile}
    echo >> ${mdfile}
    echo '-----' >> ${mdfile}
    echo '*please note: this file is generated, edits will be lost*' >> ${mdfile}
    printf "."
done
printf " "

###############################################################################
# update 'man page' documentation in doc/man
###############################################################################

barc='proto/barc'
barc_commands='list'

${barc} -h > doc/man/barc/barc.generated.txt
for command in ${barc_commands}; do
    ${barc} ${command} -h > doc/man/barc/barc_${command}.generated.txt
done
printf "."

arcyd='proto/arcyd'
arcyd_commands='
        init list-repos add-phabricator add-repohost add-repo rm-repo start
        stop fsck fetch'

${arcyd} -h > doc/man/arcyd/arcyd.generated.txt
for command in ${arcyd_commands}; do
    ${arcyd} ${command} -h > doc/man/arcyd/arcyd_${command}.generated.txt
done
printf "."

arcyon='bin/arcyon'
arcyon_commands='
    show-config query comment raw-diff create-revision update-revision
    get-diff paste task-create task-update task-query comment-inline'

${arcyon} -h > doc/man/arcyon/arcyon.generated.txt
for command in ${arcyon_commands}; do
    ${arcyon} ${command} -h > doc/man/arcyon/arcyon_${command}.generated.txt
done
printf "."


# -----------------------------------------------------------------------------
# Copyright (C) 2013-2015 Bloomberg Finance L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ------------------------------ END-OF-FILE ----------------------------------