Skip to content

Commit

Permalink
Update docs generation to work with latest tools.mk
Browse files Browse the repository at this point in the history
* The hand-written documentation has been moved from doc/ to docs/ so
  as not to conflict with generated edocs. .gitignore and rebar.config
  were updated to reflect this change.
* Added latest tools.mk which includes the upload-docs target for use
  in buildbot.
  • Loading branch information
Sean Cribbs committed Aug 26, 2014
1 parent 1d4f848 commit 8b35d9e
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
ebin
.local_dialyzer_plt
deps/*
edoc
doc
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
3 changes: 1 addition & 2 deletions rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
warn_untyped_record,
{parse_transform, lager_transform}]}.
{eunit_opts, [verbose]}.
{edoc_opts, [preprocess,
{dir, "edoc"}]}.
{edoc_opts, [preprocess]}.
{cover_enabled, true}.
{xref_checks, [undefined_function_calls]}.
{deps, [{lager, "2.0.3", {git, "git://github.com/basho/lager.git", {tag, "2.0.3"}}},
Expand Down
39 changes: 38 additions & 1 deletion tools.mk
Original file line number Diff line number Diff line change
@@ -1,11 +1,49 @@
# -------------------------------------------------------------------
#
# Copyright (c) 2014 Basho Technologies, Inc.
#
# This file is provided to you 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.
#
# -------------------------------------------------------------------

# -------------------------------------------------------------------
# NOTE: This file is is from https://github.com/basho/tools.mk.
# It should not be edited in a project. It should simply be updated
# wholesale when a new version of tools.mk is released.
# -------------------------------------------------------------------

REBAR ?= ./rebar
REVISION ?= $(shell git rev-parse --short HEAD)
PROJECT ?= $(shell basename `find src -name "*.app.src"` .app.src)

.PHONY: compile-no-deps test docs xref dialyzer-run dialyzer-quick dialyzer \
cleanplt upload-docs

compile-no-deps:
${REBAR} compile skip_deps=true

test: compile
${REBAR} eunit skip_deps=true

upload-docs: docs
@if [ -z "${BUCKET}" -o -z "${PROJECT}" -o -z "${REVISION}" ]; then \
echo "Set BUCKET, PROJECT, and REVISION env vars to upload docs"; \
exit 1; fi
@cd doc; s3cmd put -P * "s3://${BUCKET}/${PROJECT}/${REVISION}/" > /dev/null
@echo "Docs built at: http://${BUCKET}.s3-website-us-east-1.amazonaws.com/${PROJECT}/${REVISION}"

docs:
${REBAR} doc skip_deps=true

Expand Down Expand Up @@ -109,4 +147,3 @@ cleanplt:
sleep 5
rm $(PLT)
rm $(LOCAL_PLT)

5 comments on commit 8b35d9e

@reiddraper
Copy link
Contributor

Choose a reason for hiding this comment

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

+1, thanks!

@borshop
Copy link
Contributor

Choose a reason for hiding this comment

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

saw approval from reiddraper
at 8b35d9e

@borshop
Copy link
Contributor

Choose a reason for hiding this comment

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

merging basho/riak_ensemble/bugfix/sdc/edoc-generation = 8b35d9e into borshop-integration-54-bugfix/sdc/edoc-generation

@borshop
Copy link
Contributor

Choose a reason for hiding this comment

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

basho/riak_ensemble/bugfix/sdc/edoc-generation = 8b35d9e merged ok, testing candidate = fecb270

@borshop
Copy link
Contributor

Choose a reason for hiding this comment

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

Please sign in to comment.