https://github.com/celery/sphinx_celery
Celery Sphinx Theme and Utilities
https://github.com/celery/sphinx_celery
documentation python sphinx-extension sphinx-theme theme
Last synced: 24 days ago
JSON representation
Celery Sphinx Theme and Utilities
- Host: GitHub
- URL: https://github.com/celery/sphinx_celery
- Owner: celery
- License: other
- Created: 2016-04-08T00:20:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T16:43:36.000Z (about 2 months ago)
- Last Synced: 2025-04-20T08:22:34.519Z (about 1 month ago)
- Topics: documentation, python, sphinx-extension, sphinx-theme, theme
- Language: Python
- Size: 95.7 KB
- Stars: 6
- Watchers: 7
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: Changelog
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
=====================================================================
Celery Sphinx Utilities
=====================================================================
:Version: 2.1.3
:Download: http://pypi.python.org/pypi/sphinx_celery/
:Source: http://github.com/celery/sphinx_celery/
:Keywords: Sphinx, documentation, python
About
=====
This project provides the Celery sphinx theme and common Sphinx utilities.
.. _installation:
Installation
============
You can install sphinx_celery either via the Python Package Index (PyPI)
or from source.
To install using `pip`,::
$ pip install -U sphinx_celery
To install using `easy_install`,::
$ easy_install -U sphinx_celery
.. _installing-from-source:
Downloading and installing from source
--------------------------------------
Download the latest version of sphinx_celery from
http://pypi.python.org/pypi/sphinx_celery/
You can install it by doing the following,::
$ tar xvfz sphinx_celery.0.0.tar.gz
$ cd sphinx_celery.0.0
$ python setup.py build
# python setup.py install
The last command must be executed as a privileged user if
you are not currently using a virtualenv.
.. _installing-from-git:
Using the development version
-----------------------------
With pip
~~~~~~~~
You can install the latest snapshot of sphinx_celery using the following
pip command::
$ pip install https://github.com/celery/sphinx_celery/zipball/master#egg=sphinx_celery