docs: Rename dev docs to devtools
This commit is contained in:
parent
2ac1cc4582
commit
ad1904023e
@ -93,7 +93,7 @@ For more documentation on testing, check out the `nose documentation
|
|||||||
Submitting changes
|
Submitting changes
|
||||||
==================
|
==================
|
||||||
|
|
||||||
- One branch per feature or fix.
|
- One branch per feature or fix. Keep branches small and on topic.
|
||||||
|
|
||||||
- Follow the :ref:`style guide <codestyle>`_, especially make sure ``flake8``
|
- Follow the :ref:`style guide <codestyle>`_, especially make sure ``flake8``
|
||||||
does not complain about anything.
|
does not complain about anything.
|
||||||
|
|||||||
@ -1,19 +1,8 @@
|
|||||||
***********
|
*****************
|
||||||
Development
|
Development tools
|
||||||
***********
|
*****************
|
||||||
|
|
||||||
Commit guidelines
|
Here you'll find description of the development tools we use.
|
||||||
=================
|
|
||||||
|
|
||||||
- We follow the development process described at
|
|
||||||
`nvie.com <http://nvie.com/posts/a-successful-git-branching-model/>`_.
|
|
||||||
|
|
||||||
- Keep commits small and on topic.
|
|
||||||
|
|
||||||
- If a commit looks too big you should be working in a feature branch not a
|
|
||||||
single commit.
|
|
||||||
|
|
||||||
- Merge feature branches with ``--no-ff`` to keep track of the merge.
|
|
||||||
|
|
||||||
|
|
||||||
Continuous integration
|
Continuous integration
|
||||||
@ -38,8 +27,8 @@ code. So, if you're out of work, the code coverage and pylint data at the CI
|
|||||||
server should give you a place to start.
|
server should give you a place to start.
|
||||||
|
|
||||||
|
|
||||||
Protocol debugging
|
Protocol debugger
|
||||||
==================
|
=================
|
||||||
|
|
||||||
Since the main interface provided to Mopidy is through the MPD protocol, it is
|
Since the main interface provided to Mopidy is through the MPD protocol, it is
|
||||||
crucial that we try and stay in sync with protocol developments. In an attempt
|
crucial that we try and stay in sync with protocol developments. In an attempt
|
||||||
@ -82,35 +71,12 @@ both to use ``tests/data/advanced_tag_cache`` for their tag cache and
|
|||||||
playlists.
|
playlists.
|
||||||
|
|
||||||
|
|
||||||
Setting profiles during development
|
Documentation writing
|
||||||
===================================
|
|
||||||
|
|
||||||
While developing Mopidy switching settings back and forth can become an all too
|
|
||||||
frequent occurrence. As a quick hack to get around this you can structure your
|
|
||||||
settings file in the following way::
|
|
||||||
|
|
||||||
import os
|
|
||||||
profile = os.environ.get('PROFILE', '').split(',')
|
|
||||||
|
|
||||||
if 'shoutcast' in profile:
|
|
||||||
OUTPUT = u'lame ! shout2send mount="/stream"'
|
|
||||||
elif 'silent' in profile:
|
|
||||||
OUTPUT = u'fakesink'
|
|
||||||
MIXER = None
|
|
||||||
|
|
||||||
SPOTIFY_USERNAME = u'xxxxx'
|
|
||||||
SPOTIFY_PASSWORD = u'xxxxx'
|
|
||||||
|
|
||||||
Using this setup you can now run Mopidy with ``PROFILE=silent mopidy``
|
|
||||||
if you for instance want to test Spotify without any actual audio output.
|
|
||||||
|
|
||||||
|
|
||||||
Writing documentation
|
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
To write documentation, we use `Sphinx <http://sphinx-doc.org/>`_. See their
|
To write documentation, we use `Sphinx <http://sphinx-doc.org/>`_. See their
|
||||||
site for lots of documentation on how to use Sphinx. To generate HTML or LaTeX
|
site for lots of documentation on how to use Sphinx. To generate HTML from the
|
||||||
from the documentation files, you need some additional dependencies.
|
documentation files, you need some additional dependencies.
|
||||||
|
|
||||||
You can install them through Debian/Ubuntu package management::
|
You can install them through Debian/Ubuntu package management::
|
||||||
|
|
||||||
@ -60,7 +60,7 @@ Development
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
contributing
|
contributing
|
||||||
development
|
devtools
|
||||||
codestyle
|
codestyle
|
||||||
extensiondev
|
extensiondev
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user