diff --git a/README.rst b/README.rst index a5bfbc3..7f9ce24 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,7 @@ Here are a few quickstart tutorials for the most common images. If you plan on partitioning your volume, you will need the ``parted`` package and ``kpartx``: -.. code:: sh +.. code-block:: sh root@host:~# apt-get install parted kpartx @@ -75,7 +75,7 @@ quits the process. Docker ~~~~~~ -.. code:: sh +.. code-block:: sh user@host:~$ sudo -i # become root root@host:~# git clone https://github.com/andsens/bootstrap-vz.git # Clone the repo @@ -93,7 +93,7 @@ it is recommended to install `the latest docker version `__, since bootstrap-vz supports `yaml `__, you can avoid a lot of curly braces quotes: -.. code:: yaml +.. code-block:: yaml $schema: http://json-schema.org/draft-04/schema# title: Example plugin manifest @@ -110,7 +110,7 @@ specific to your use-case or when the plugin contains proprietary code that you would not like to share. They integrate with bootstrap-vz by exposing an entry-point through ``setup.py``: -.. code:: python +.. code-block:: python setup(name='example-plugin', version=0.9.5, @@ -123,7 +123,7 @@ They integrate with bootstrap-vz by exposing an entry-point through ``setup.py`` Beyond ``setup.py`` the package might need a ``MANIFEST.in`` so that assets like ``manifest-schema.yml`` are included when the package is built: -.. code:: +.. code-block:: text include example/manifest-schema.yml include example/README.rst @@ -141,6 +141,6 @@ Some plugins may not find their way to the python package index (especially if it's in a private repo). They can of course still be installed using pip: -.. code:: sh +.. code-block:: sh pip install git+ssh://git@github.com/username/repo#egg=plugin_name diff --git a/tests/README.rst b/tests/README.rst index c14730c..ee59591 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -9,7 +9,7 @@ Selecting tests --------------- To run one specific test suite simply append the module path to tox: -.. code:: sh +.. code-block:: sh $ tox -e unit tests.unit.releases_tests @@ -17,6 +17,6 @@ Specific tests can be selected by appending the function name with a colon to the modulepath -- to run more than one tests, simply attach more arguments. -.. code:: sh +.. code-block:: sh $ tox -e unit tests.unit.releases_tests:test_lt tests.unit.releases_tests:test_eq diff --git a/tests/system/README.rst b/tests/system/README.rst index 815588e..d77c68a 100644 --- a/tests/system/README.rst +++ b/tests/system/README.rst @@ -46,7 +46,7 @@ Instead of creating manifests from scratch for each single test, reusable parts are factored out into partials in the manifest folder. This allows code like this: -.. code:: python +.. code-block:: python partials = {'vdi': '{provider: {name: virtualbox}, volume: {backing: vdi}}', 'vmdk': '{provider: {name: virtualbox}, volume: {backing: vmdk}}', diff --git a/tests/system/providers/README.rst b/tests/system/providers/README.rst index 80c6666..e16e83f 100644 --- a/tests/system/providers/README.rst +++ b/tests/system/providers/README.rst @@ -28,7 +28,7 @@ up logging and invokes a specific test can be used instead: Example: -.. code:: python +.. code-block:: python #!/usr/bin/env python diff --git a/tox.ini b/tox.ini index 8a0b7cd..0b8047e 100644 --- a/tox.ini +++ b/tox.ini @@ -32,5 +32,7 @@ commands = nosetests --with-html --html-file=system.html --verbose {posargs:test [testenv:docs] changedir = docs -deps = sphinx +deps = + sphinx + sphinx_rtd_theme commands = sphinx-build -W -b html -d _build/html/doctrees . _build/html