Skip to content

Commit

Permalink
Merge pull request #2365 from StackStorm/remove-docs
Browse files Browse the repository at this point in the history
Remove docs
  • Loading branch information
manasdk committed Jan 9, 2016
2 parents 7ca1a78 + 0330274 commit 9c69d97
Show file tree
Hide file tree
Showing 139 changed files with 7 additions and 16,288 deletions.
1 change: 0 additions & 1 deletion .scrutinizer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ build:
override:
- make .flake8
- make .pylint
- make .docs
checks:
python:
code_rating: true
Expand Down
49 changes: 3 additions & 46 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ SHELL := /bin/bash
TOX_DIR := .tox
VIRTUALENV_DIR ?= virtualenv

# Sphinx docs options
SPHINXBUILD := sphinx-build
DOC_SOURCE_DIR := docs/source
DOC_BUILD_DIR := docs/build

BINARIES := bin

# All components are prefixed by st2
Expand Down Expand Up @@ -36,7 +31,7 @@ ifndef PIP_OPTIONS
endif

.PHONY: all
all: requirements check tests docs
all: requirements check tests

# Target for debugging Makefile variable assembly
.PHONY: play
Expand All @@ -57,39 +52,6 @@ checklogs:
@echo
. $(VIRTUALENV_DIR)/bin/activate; ./tools/log_watcher.py 10

.PHONY: docs
docs: requirements .docs

.PHONY: .docs
.docs:
@echo
@echo "====================docs===================="
@echo
@echo "# Sample config which contains all the available options which the corresponding descriptions" > conf/st2.conf.sample
@echo "# Note: This file is automatically generated using tools/config_gen.py" >> conf/st2.conf.sample
@echo "" >> conf/st2.conf.sample
. $(VIRTUALENV_DIR)/bin/activate; ./tools/config_gen.py >> conf/st2.conf.sample
. $(VIRTUALENV_DIR)/bin/activate; ./scripts/generate-runner-parameters-documentation.py
. $(VIRTUALENV_DIR)/bin/activate; ./scripts/generate-internal-triggers-table.py
. $(VIRTUALENV_DIR)/bin/activate; ./scripts/generate-available-permission-types-table.py
@echo
. $(VIRTUALENV_DIR)/bin/activate; $(SPHINXBUILD) -W -b html $(DOC_SOURCE_DIR) $(DOC_BUILD_DIR)/html
@echo
@echo "Build finished. The HTML pages are in $(DOC_BUILD_DIR)/html."

.PHONY: livedocs
livedocs: docs .livedocs

.PHONY: .livedocs
.livedocs:
@echo
@echo "==========================================================="
@echo " RUNNING DOCS"
@echo "==========================================================="
@echo
. $(VIRTUALENV_DIR)/bin/activate; sphinx-autobuild -H 0.0.0.0 -b html $(DOC_SOURCE_DIR) $(DOC_BUILD_DIR)/html
@echo

.PHONY: pylint
pylint: requirements .pylint

Expand Down Expand Up @@ -134,7 +96,7 @@ lint: requirements .lint
.lint: .flake8 .pylint

.PHONY: clean
clean: .cleanpycs .cleandocs
clean: .cleanpycs

.PHONY: compile
compile:
Expand All @@ -160,11 +122,6 @@ compile:
find ${ROOT_DIR}/st2common/st2common/ -name \*.py -type f -print0 | xargs -0 cat | grep st2api ; test $$? -eq 1
find ${ROOT_DIR}/st2common/st2common/ -name \*.py -type f -print0 | xargs -0 cat | grep st2auth ; test $$? -eq 1

.PHONY: .cleandocs
.cleandocs:
@echo "Removing generated documentation"
rm -rf $(DOC_BUILD_DIR)

.PHONY: .cleanmongodb
.cleanmongodb:
@echo "==================== cleanmongodb ===================="
Expand Down Expand Up @@ -392,7 +349,7 @@ debs:
@for component in $(COMPONENTS_TEST); do\
cp -f ./scripts/dist_utils.py $$component/dist_utils.py;\
done

# Copy over CHANGELOG.RST, CONTRIBUTING.RST and LICENSE file to each component directory
#@for component in $(COMPONENTS_TEST); do\
# test -s $$component/README.rst || cp -f README.rst $$component/; \
Expand Down
1 change: 0 additions & 1 deletion docs/.gitingnore

This file was deleted.

177 changes: 0 additions & 177 deletions docs/Makefile.generated

This file was deleted.

109 changes: 0 additions & 109 deletions docs/README.md

This file was deleted.

Binary file removed docs/StackStormLogoSquare-small.png
Binary file not shown.

0 comments on commit 9c69d97

Please sign in to comment.