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

remove documentation build + artifacts - moving to central docs repo #311

Merged
merged 1 commit into from
May 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,11 @@ GIT_COMMIT ?= $(shell git rev-parse --short HEAD 2> /dev/null || true)
BUILD_DATE := $(shell date -u +%Y-%m-%dT%T 2> /dev/null)


.PHONY: api-doc
api-doc: ## Open the locally generated HTML API reference
@open ./docs/index.html || echo "API doc not found locally. To generate, run: 'make docs'"

.PHONY: clean
clean: ## Clean up build and test artifacts
rm -rf build/ dist/ *.egg-info htmlcov/ .coverage* .pytest_cache/ \
synse_server/__pycache__ synse_server/__pycache__ results/

.PHONY: clean-docs
clean-docs: ## Clean out the documentation build artifacts
@bin/clean_docs.sh

.PHONY: cover
cover: test-unit ## Run unit tests and open their resulting HTML coverage report
open ./results/cov-html/index.html
Expand All @@ -40,19 +32,6 @@ docker: ## Build the docker image locally
-t ${IMAGE_NAME}:local \
-t ${IMAGE_NAME}:latest .

.PHONY: docs
docs: clean-docs ## Generate the User Guide and API documentation locally
@echo "Building User Guide (see docs/build/html/index.html for output)"
(cd docs ; make html)

@echo "Building API Documentation (see docs/index.html for output)"
docker build -f docs/Dockerfile -t vaporio/slate-docs docs
@if [ -d "docs/api/build" ]; then rm -rf docs/api/build; fi;
docker run --name slate-docs -v `pwd`/docs/api:/source vaporio/slate-docs
docker cp slate-docs:/slate/build/. docs/api/build
docker rm slate-docs
mv docs/api/build/** docs/

.PHONY: fmt
fmt: ## Automatic source code formatting (isort)
tox -e fmt
Expand Down
36 changes: 0 additions & 36 deletions bin/clean_docs.sh

This file was deleted.

14 changes: 0 additions & 14 deletions docs/Dockerfile

This file was deleted.

20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

Binary file removed docs/api/images/logo.png
Binary file not shown.
Loading