From e7e409938a35a95253f049d945944fa050eb43d2 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 6 Feb 2018 12:52:20 -0500 Subject: [PATCH] doc - Minor documentation and script comment changes --- CONTRIBUTING.md | 27 +++++++++++----------- scripts/build-install-doxygen.sh | 11 +++++++++ scripts/generateDocumentationAndDeploy.sh | 28 +++++++++-------------- 3 files changed, 36 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28df524e..74ebb558 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,20 @@ ## Contributing The following quick guides will help you get started: -+ [Becoming a Contributor](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/become-a-contributor.md) -+ [Working with GitHub](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/working-with-github.md) -+ [Setting Up Your Environment](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/setting-up-your-environment.md) -+ [Improving Developer Documentation](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/contributing-to-developer-documentation.md) -+ [Assisting with Translations](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/assisting-with-translations.md) -+ [Managing Wallets](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/managing-wallets.md) -+ [Adding Events, Release Notes and Alerts](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md) -+ [Adding Blog Posts](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-blog-posts.md) -+ [Miscellaneous / Other](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/miscellaneous.md) + ++ [Working with GitHub](https://github.com/dash-docs/dash-docs/blob/master/docs/working-with-github.md) ++ [Setting Up Your Environment](https://github.com/dash-docs/dash-docs/blob/master/docs/setting-up-your-environment.md) ++ [Improving Developer Documentation](https://github.com/dash-docs/dash-docs/blob/master/docs/contributing-to-developer-documentation.md) ++ [Miscellaneous / Other](https://github.com/dash-docs/dash-docs/blob/master/docs/miscellaneous.md) + ### Code of Conduct -Participation in this project is subject to a [Code of Conduct](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/CODE_OF_CONDUCT.md). - -### Questions? -Please contact Will Binns ([will@bitcoin.org](mailto:will@bitcoin.org)) if you need help. +Participation in this project is subject to a [Code of Conduct](https://github.com/dash-docs/dash-docs/blob/master/CODE_OF_CONDUCT.md). diff --git a/scripts/build-install-doxygen.sh b/scripts/build-install-doxygen.sh index 5fcd6aaf..0bed18a7 100644 --- a/scripts/build-install-doxygen.sh +++ b/scripts/build-install-doxygen.sh @@ -1,4 +1,15 @@ #!/bin/sh +################################################################################ +# Title : build-install-doxygen.sh +# Date created : 2018/02/01 +# Notes : +__AUTHOR__="thephez" +# +# If the doxygen binary is not found, clones the doxygen repository, builds, +# and copies the binary to a location for Travis-CI caching. +# +################################################################################ + set -ex file="$TRAVIS_BUILD_DIR/doxygen-install/doxygen" diff --git a/scripts/generateDocumentationAndDeploy.sh b/scripts/generateDocumentationAndDeploy.sh index 7c224ee6..2f7cc1e9 100644 --- a/scripts/generateDocumentationAndDeploy.sh +++ b/scripts/generateDocumentationAndDeploy.sh @@ -2,23 +2,18 @@ ################################################################################ # Title : generateDocumentationAndDeploy.sh # Date created : 2016/02/22 -# Notes : +# Notes : Modified the thephez for deploying with dash-docs __AUTHOR__="Jeroen de Bruijn" # Preconditions: -# - Packages doxygen doxygen-doc doxygen-latex doxygen-gui graphviz -# must be installed. -# - Doxygen configuration file must have the destination directory empty and -# source code directory with a $(TRAVIS_BUILD_DIR) prefix. -# - An gh-pages branch should already exist. See below for mor info on hoe to -# create a gh-pages branch. +# - Doxygen must be installed or loaded from cache. The build-install-doxygen +# script should be used to do this +# - A Doxygen configuration file must be located in the TRAVIS_BUILD_DIR/doxygen +# directory +# - This script should be called after the rest of the site has already been +# built (i.e. in the Travis-CI after_success section) # # Required global variables: -# - TRAVIS_BUILD_NUMBER : The number of the current build. -# - TRAVIS_COMMIT : The commit that the current build is testing. # - DOXYFILE : The Doxygen configuration file. -# - GH_REPO_NAME : The name of the repository. -# - GH_REPO_REF : The GitHub reference to the repository. -# - GH_REPO_TOKEN : Secure token to the github repository. # # For information on how to encrypt variables for Travis CI please go to # https://docs.travis-ci.com/user/environment-variables/#Encrypted-Variables @@ -26,15 +21,14 @@ __AUTHOR__="Jeroen de Bruijn" # For information on how to create a clean gh-pages branch from the master # branch, please go to https://gist.github.com/vidavidorra/846a2fc7dd51f4fe56a0 # -# This script will generate Doxygen documentation and push the documentation to -# the gh-pages branch of a repository specified by GH_REPO_REF. -# Before this script is used there should already be a gh-pages branch in the -# repository. +# This script will generate Doxygen documentation and copy the documentation to +# the _site/_en directory of dash-docs so it can be deployed with the rest of +# the site # ################################################################################ ################################################################################ -##### Setup this script and get the current gh-pages branch. ##### +##### Setup this script and clone the Dash repository ##### echo 'Setting up the script...' # Exit with nonzero exit code if anything fails set -e