From ad1904023e7a876562efe283aa52d5f53705adab Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Apr 2013 01:01:25 +0200 Subject: [PATCH] docs: Rename dev docs to devtools --- docs/contributing.rst | 2 +- docs/{development.rst => devtools.rst} | 52 +++++--------------------- docs/index.rst | 2 +- 3 files changed, 11 insertions(+), 45 deletions(-) rename docs/{development.rst => devtools.rst} (73%) diff --git a/docs/contributing.rst b/docs/contributing.rst index 70326145..215aea65 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -93,7 +93,7 @@ For more documentation on testing, check out the `nose documentation 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 `_, especially make sure ``flake8`` does not complain about anything. diff --git a/docs/development.rst b/docs/devtools.rst similarity index 73% rename from docs/development.rst rename to docs/devtools.rst index 580178f1..7b5b2f81 100644 --- a/docs/development.rst +++ b/docs/devtools.rst @@ -1,19 +1,8 @@ -*********** -Development -*********** +***************** +Development tools +***************** -Commit guidelines -================= - -- We follow the development process described at - `nvie.com `_. - -- 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. +Here you'll find description of the development tools we use. 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. -Protocol debugging -================== +Protocol debugger +================= 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 @@ -82,35 +71,12 @@ both to use ``tests/data/advanced_tag_cache`` for their tag cache and playlists. -Setting profiles during development -=================================== - -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 +Documentation writing ===================== To write documentation, we use `Sphinx `_. See their -site for lots of documentation on how to use Sphinx. To generate HTML or LaTeX -from the documentation files, you need some additional dependencies. +site for lots of documentation on how to use Sphinx. To generate HTML from the +documentation files, you need some additional dependencies. You can install them through Debian/Ubuntu package management:: diff --git a/docs/index.rst b/docs/index.rst index 6f5ef95f..199ba31c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,7 +60,7 @@ Development :maxdepth: 1 contributing - development + devtools codestyle extensiondev