Skip to content

Commit

Permalink
Use sphinx_celery to manage Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
ask committed Apr 8, 2016
1 parent 1b85a1a commit 8bc66b7
Show file tree
Hide file tree
Showing 21 changed files with 499 additions and 794 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ dist/
*.egg-info
*.egg
*.egg/
doc/__build/*
build/
.build/
_build/
pip-log.txt
.directory
erl_crash.dump
Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ dependencies, so install these next:
$ pip install -U -r requirements/default.txt

After installing the dependencies required, you can now execute
the test suite by calling ``nosetests``:
the test suite by calling ``nosetests <nose>``:
::

$ nosetests
Expand All @@ -472,7 +472,7 @@ Some useful options to ``nosetests`` are:

Don't capture output

* ``--nologcapture``
* ``-nologcapture``

Don't capture log output.

Expand Down Expand Up @@ -543,8 +543,7 @@ To run the tests for all supported Python versions simply execute:

$ tox

If you only want to test specific Python versions use the ``-e``
option:
Use the ``tox -e`` option if you only want to test specific Python versions:
::

$ tox -e 2.7
Expand All @@ -563,11 +562,11 @@ build the docs by running:
::

$ cd docs
$ rm -rf .build
$ rm -rf _build
$ make html

Make sure there are no errors or warnings in the build output.
After building succeeds the documentation is available at ``.build/html``.
After building succeeds the documentation is available at ``_build/html``.

.. _contributing-verify:

Expand Down Expand Up @@ -1058,7 +1057,8 @@ and make a new version tag:
Releasing
---------

Commands to make a new public stable release::
Commands to make a new public stable release:
::

$ make distcheck # checks pep8, autodoc index, runs tests and more
$ make dist # NOTE: Runs git clean -xdf and removes files not in the repo.
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PROJ=celery
PYTHON=python
SPHINX_DIR="docs/"
SPHINX_BUILDDIR="${SPHINX_DIR}/.build"
SPHINX_BUILDDIR="${SPHINX_DIR}/_build"
README="README.rst"
CONTRIBUTING="CONTRIBUTING.rst"
CONFIGREF_SRC="docs/configuration.rst"
Expand Down
15 changes: 10 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,13 @@ Installation
You can install Celery either via the Python Package Index (PyPI)
or from source.

To install using `pip`,::
To install using `pip`,:
::

$ pip install -U Celery

To install using `easy_install`,::
To install using `easy_install`,:
::

$ easy_install -U Celery

Expand Down Expand Up @@ -330,7 +332,8 @@ Downloading and installing from source
Download the latest version of Celery from
http://pypi.python.org/pypi/celery/

You can install it by doing the following,::
You can install it by doing the following,:
::

$ tar xvfz celery-0.0.0.tar.gz
$ cd celery-0.0.0
Expand All @@ -349,15 +352,17 @@ With pip
~~~~~~~~

The Celery development version also requires the development
versions of ``kombu``, ``amqp`` and ``billiard``.
versions of ``kombu``, ``amqp``, ``billiard`` and ``vine``.

You can install the latest snapshot of these using the following
pip commands::
pip commands:
::

$ pip install https://github.com/celery/celery/zipball/master#egg=celery
$ pip install https://github.com/celery/billiard/zipball/master#egg=billiard
$ pip install https://github.com/celery/py-amqp/zipball/master#egg=amqp
$ pip install https://github.com/celery/kombu/zipball/master#egg=kombu
$ pip install https://github.com/celery/vine/zipball/master#egg=vine

With git
~~~~~~~~
Expand Down
21 changes: 0 additions & 21 deletions docs/.templates/page.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/.templates/sidebarlogo.html

This file was deleted.

Loading

0 comments on commit 8bc66b7

Please sign in to comment.