forked from celery/kombu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate README.rst from docs/templates/readme.txt
- Loading branch information
Showing
7 changed files
with
499 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,116 @@ | ||
| PROJ=kombu | ||
| PYTHON=python | ||
| SPHINX_DIR="docs/" | ||
| GIT=git | ||
| TOX=tox | ||
| NOSETESTS=nosetests | ||
| ICONV=iconv | ||
| FLAKE8=flake8 | ||
| FLAKEPLUS=flakeplus | ||
|
|
||
| SPHINX_DIR=docs/ | ||
| SPHINX_BUILDDIR="${SPHINX_DIR}/_build" | ||
| README="README.rst" | ||
| README=README.rst | ||
| README_SRC="docs/templates/readme.txt" | ||
| CONTRIBUTING_SRC="docs/contributing.rst" | ||
| SPHINX2RST="sphinx2rst" | ||
|
|
||
| SPHINX_HTMLDIR = "${SPHINX_BUILDDIR}/html" | ||
|
|
||
| html: | ||
| DOCUMENTATION=Documentation | ||
| FLAKEPLUSTARGET=2.7 | ||
|
|
||
| all: help | ||
|
|
||
| help: | ||
| @echo "docs - Build documentation." | ||
| @echo "test-all - Run tests for all supported python versions." | ||
| @echo "distcheck ---------- - Check distribution for problems." | ||
| @echo " test - Run unittests using current python." | ||
| @echo " lint ------------ - Check codebase for problems." | ||
| @echo " apicheck - Check API reference coverage." | ||
| @echo " configcheck - Check configuration reference coverage." | ||
| @echo " readmecheck - Check README encoding." | ||
| @echo " flakes -------- - Check code for syntax and style errors." | ||
| @echo " flakecheck - Run flake8 on the source code." | ||
| @echo " flakepluscheck - Run flakeplus on the source code." | ||
| @echo "readme - Regenerate README.rst file." | ||
| @echo "clean-dist --------- - Clean all distribution build artifacts." | ||
| @echo " clean-git-force - Remove all uncomitted files." | ||
| @echo " clean ------------ - Non-destructive clean" | ||
| @echo " clean-pyc - Remove .pyc/__pycache__ files" | ||
| @echo " clean-docs - Remove documentation build artifacts." | ||
| @echo " clean-build - Remove setup artifacts." | ||
|
|
||
| clean: clean-docs clean-pyc clean-build | ||
|
|
||
| clean-dist: clean clean-git-force | ||
|
|
||
| Documentation: | ||
| (cd "$(SPHINX_DIR)"; $(MAKE) html) | ||
| mv "$(SPHINX_HTMLDIR)" Documentation | ||
| mv "$(SPHINX_HTMLDIR)" $(DOCUMENTATION) | ||
|
|
||
| docsclean: | ||
| docs: Documentation | ||
|
|
||
| clean-docs: | ||
| -rm -rf "$(SPHINX_BUILDDIR)" | ||
|
|
||
| htmlclean: | ||
| (cd "$(SPHINX_DIR)"; $(MAKE) clean) | ||
| lint: flakecheck apicheck configcheck readmecheck | ||
|
|
||
| apicheck: | ||
| (cd "$(SPHINX_DIR)"; $(MAKE) apicheck) | ||
|
|
||
| configcheck: | ||
| (cd "$(SPHINX_DIR)"; $(MAKE) configcheck) | ||
|
|
||
| flakecheck: | ||
| flake8 kombu | ||
| $(FLAKE8) "$(PROJ)" | ||
|
|
||
| flakediag: | ||
| -$(MAKE) flakecheck | ||
|
|
||
| flakepluscheck: | ||
| flakeplus --2.7 kombu | ||
| $(FLAKEPLUS) --$(FLAKEPLUSTARGET) "$(PROJ)" | ||
|
|
||
| flakeplusdiag: | ||
| -$(MAKE) flakepluscheck | ||
|
|
||
| flakes: flakediag flakeplusdiag | ||
|
|
||
| readmeclean: | ||
| clean-readme: | ||
| -rm -f $(README) | ||
|
|
||
| readmecheck: | ||
| iconv -f ascii -t ascii $(README) >/dev/null | ||
| $(ICONV) -f ascii -t ascii $(README) >/dev/null | ||
|
|
||
| $(README): | ||
| $(SPHINX2RST) $(README_SRC) --ascii > $@ | ||
|
|
||
| readme: readmeclean $(README) readmecheck | ||
|
|
||
| test: | ||
| nosetests -xv kombu.tests | ||
|
|
||
| cov: | ||
| nosetests -xv kombu.tests --with-coverage --cover-html --cover-branch | ||
| readme: clean-readme $(README) readmecheck | ||
|
|
||
| removepyc: | ||
| clean-pyc: | ||
| -find . -type f -a \( -name "*.pyc" -o -name "*$$py.class" \) | xargs rm | ||
| -find . -type d -name "__pycache__" | xargs rm -r | ||
|
|
||
| gitclean: | ||
| git clean -xdn | ||
| removepyc: clean-pyc | ||
|
|
||
| gitcleanforce: | ||
| git clean -xdf | ||
| clean-build: | ||
| rm -rf build/ dist/ .eggs/ *.egg-info/ .tox/ .coverage cover/ | ||
|
|
||
| clean-git: | ||
| $(GIT) clean -xdn | ||
|
|
||
| clean-git-force: | ||
| $(GIT) clean -xdf | ||
|
|
||
| test-all: clean-pyc | ||
| $(TOX) | ||
|
|
||
| test: | ||
| $(PYTHON) setup.py test | ||
|
|
||
| cov: | ||
| $(NOSETESTS) -xv --with-coverage --cover-html --cover-branch | ||
|
|
||
| tox: removepyc | ||
| tox | ||
| build: | ||
| $(PYTHON) setup.py sdist bdist_wheel | ||
|
|
||
| distcheck: flakecheck apicheck readmecheck test gitclean | ||
| distcheck: lint test clean | ||
|
|
||
| dist: readme docsclean gitcleanforce removepyc | ||
| dist: readme clean-dist build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| Installation | ||
| ============ | ||
|
|
||
| You can install `Kombu` either via the Python Package Index (PyPI) | ||
| or from source. | ||
|
|
||
| To install using `pip`,: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| $ pip install kombu | ||
|
|
||
| To install using `easy_install`,: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| $ easy_install kombu | ||
|
|
||
| If you have downloaded a source tarball you can install it | ||
| by doing the following,: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| $ python setup.py build | ||
| # python setup.py install # as root | ||
|
|
||
|
|
Oops, something went wrong.