Skip to content

Commit

Permalink
Fix docs path in .gitignore and Makefile (#5217)
Browse files Browse the repository at this point in the history
* Fix docs directory in .gitignore (renamed in #4937)

* Fix docs directory in Makefile (renamed in #4937)

* Fix docs directory in bin/ci (renamed in #4937)
  • Loading branch information
straight-shoota authored and RX14 committed Oct 31, 2017
1 parent fbab3a3 commit e095e93
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Expand Up @@ -10,7 +10,7 @@ coverage/
/Makefile.local
all_spec
/tmp
/doc/
/docs/
/src/llvm/ext/llvm_ext.o
/src/llvm/ext/llvm_ext.dwo
/src/ext/*.o
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -81,7 +81,7 @@ The [standard library documentation](https://crystal-lang.org/api/) is on the co
There is a version updated with every push to the master branch [here](https://crystal-lang.org/api/master/).
It uses a subset of [Markdown](http://daringfireball.net/projects/markdown/). You can [use Ruby as a source
of inspiration](https://twitter.com/yukihiro_matz/status/549317901002342400) whenever applicable. To generate
the docs execute `make doc`. Please follow the guidelines described in our
the docs execute `make docs`. Please follow the guidelines described in our
[language documentation](https://crystal-lang.org/docs/conventions/documenting_code.html), like the use of the third person.

### The standard library
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Expand Up @@ -88,9 +88,9 @@ std_spec: $(O)/std_spec ## Run standard library specs
compiler_spec: $(O)/compiler_spec ## Run compiler specs
$(O)/compiler_spec $(SPEC_FLAGS)

.PHONY: doc
doc: ## Generate standard library documentation
$(BUILD_PATH) ./bin/crystal doc src/docs_main.cr
.PHONY: docs
docs: ## Generate standard library documentation
$(BUILD_PATH) ./bin/crystal docs src/docs_main.cr

.PHONY: crystal
crystal: $(O)/crystal ## Build the compiler
Expand Down
8 changes: 4 additions & 4 deletions bin/ci
Expand Up @@ -84,19 +84,19 @@ prepare_system() {

build() {
with_build_env 'make std_spec clean'
with_build_env 'make crystal std_spec compiler_spec doc'
with_build_env 'make crystal std_spec compiler_spec docs'
with_build_env 'find samples -name "*.cr" | xargs -L 1 ./bin/crystal build --no-codegen'
with_build_env './bin/crystal tool format --check samples spec src'
}

deploy() {
export CURRENT_TAG=`git describe --tags --exact-match 2> /dev/null`
export GIT_VERSION=`git describe --tags --long --always 2>/dev/null`
on_deploy 'echo $GIT_VERSION > doc/revision.txt'
on_deploy 'echo $GIT_VERSION > docs/revision.txt'

on_deploy aws s3 sync doc/ s3://crystal-api/api/$TRAVIS_BRANCH
on_deploy aws s3 sync docs/ s3://crystal-api/api/$TRAVIS_BRANCH

on_deploy on_tag aws s3 sync doc/ s3://crystal-api/api/$CURRENT_TAG
on_deploy on_tag aws s3 sync docs/ s3://crystal-api/api/$CURRENT_TAG
cat - > .aws-config <<EOF
{
"IndexDocument": {
Expand Down

0 comments on commit e095e93

Please sign in to comment.