Skip to content

Commit

Permalink
Merge 25a9e8b into b315915
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulinaLach committed Feb 1, 2017
2 parents b315915 + 25a9e8b commit 7481382
Show file tree
Hide file tree
Showing 10 changed files with 29 additions and 13 deletions.
1 change: 1 addition & 0 deletions .editorconfig
Expand Up @@ -39,6 +39,7 @@ indent_size = 4
known_first_party = invenio_celery
multi_line_output = 2
default_section = THIRDPARTY
skip = .eggs

# RST files (used by sphinx)
[*.rst]
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -58,3 +58,6 @@ docs/_build/

# PyBuilder
target/

# Vim swapfiles
.*.sw?
1 change: 1 addition & 0 deletions .travis.yml
Expand Up @@ -46,6 +46,7 @@ python:
matrix:
allow_failures:
- python: pypy
fast_finish: true

before_install:
- "travis_retry pip install --upgrade pip setuptools py"
Expand Down
13 changes: 9 additions & 4 deletions CONTRIBUTING.rst
Expand Up @@ -53,9 +53,9 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `invenio` for local development.
Ready to contribute? Here's how to set up `invenio-celery` for local development.

1. Fork the `invenio` repo on GitHub.
1. Fork the `inveniosoftware/invenio-celery` repo on GitHub.
2. Clone your fork locally:

.. code-block:: console
Expand Down Expand Up @@ -95,7 +95,12 @@ Ready to contribute? Here's how to set up `invenio` for local development.
.. code-block:: console
$ git add .
$ git commit -s -m "Your detailed description of your changes."
$ git commit -s
-m "component: title without verbs"
-m "* NEW Adds your new feature."
-m "* FIX Fixes an existing issue."
-m "* BETTER Improves and existing feature."
-m "* Changes something that should not be visible in release notes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
Expand All @@ -109,5 +114,5 @@ Before you submit a pull request, check that it meets these guidelines:
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring.
3. The pull request should work for Python 2.7, 3.3, 3.4 and 3.5. Check
https://travis-ci.com/inveniosoftware/invenio-celery/pull_requests
https://travis-ci.org/inveniosoftware/invenio-celery/pull_requests
and make sure that the tests pass for all supported Python versions.
6 changes: 6 additions & 0 deletions INSTALL.rst
@@ -1,2 +1,8 @@
Installation
============

Invenio-Celery is on PyPI so all you need is:

.. code-block:: console
$ pip install invenio-celery
2 changes: 1 addition & 1 deletion MANIFEST.in
Expand Up @@ -33,9 +33,9 @@ include *.txt
include .lgtm
include LICENSE
include MAINTAINERS
include babel.ini
include docs/requirements.txt
include pytest.ini
prune docs/_build
recursive-include docs *.bat
recursive-include docs *.py
recursive-include docs *.rst
Expand Down
8 changes: 4 additions & 4 deletions docs/Makefile
Expand Up @@ -87,9 +87,9 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cookiecutterproject_name.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Invenio-Celery.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cookiecutterproject_name.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Invenio-Celery.qhc"

applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
Expand All @@ -104,8 +104,8 @@ devhelp:
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/cookiecutterproject_name"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cookiecutterproject_name"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Invenio-Celery"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Invenio-Celery"
@echo "# devhelp"

epub:
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Expand Up @@ -22,6 +22,8 @@
# waive the privileges and immunities granted to it by virtue of its status
# as an Intergovernmental Organization or submit itself to any jurisdiction.

"""Sphinx configuration."""

from __future__ import print_function

import os
Expand Down
4 changes: 2 additions & 2 deletions docs/make.bat
Expand Up @@ -127,9 +127,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\cookiecutterproject_name.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Invenio-Celery.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cookiecutterproject_name.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Invenio-Celery.ghc
goto end
)

Expand Down
2 changes: 0 additions & 2 deletions setup.py
Expand Up @@ -25,10 +25,8 @@
"""Celery module for Invenio."""

import os
import sys

from setuptools import find_packages, setup
from setuptools.command.test import test as TestCommand

readme = open('README.rst').read()
history = open('CHANGES.rst').read()
Expand Down

0 comments on commit 7481382

Please sign in to comment.