Move developer doc stuff into developers/ subfolder

This commit is contained in:
Anders Ingemann 2015-04-12 15:12:37 +02:00
parent 65ddee99d7
commit 188672404b
15 changed files with 28 additions and 28 deletions

View file

@ -136,13 +136,13 @@ Developers
The API documentation, development guidelines and an explanation of The API documentation, development guidelines and an explanation of
bootstrap-vz internals can be found at bootstrap-vz internals can be found at
`bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org>`__. `bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org/en/master/developers>`__.
Contributing Contributing
------------ ------------
Contribution guidelines are described in the documentation under Contribution guidelines are described in the documentation under
`Contributing <http://bootstrap-vz.readthedocs.org/en/master/contributing.html>`__. `Contributing <http://bootstrap-vz.readthedocs.org/en/master/developers/contributing.html>`__.
There's also There's also
`a topic <http://bootstrap-vz.readthedocs.org/en/master/contributing.html#coding-style>`__ `a topic <http://bootstrap-vz.readthedocs.org/en/master/developers/contributing.html#coding-style>`__
regarding the coding style. regarding the coding style.

View file

@ -26,7 +26,7 @@ class window.TaskOverview
constructor: ({@selector}) -> constructor: ({@selector}) ->
@svg = d3.select(@selector) @svg = d3.select(@selector)
.attr('viewBox', "0 0 #{viewBoxWidth} #{viewBoxHeight}") .attr('viewBox', "0 0 #{viewBoxWidth} #{viewBoxHeight}")
d3.json '_static/graph.json', @buildGraph d3.json '../_static/graph.json', @buildGraph
buildGraph: (error, @data) => buildGraph: (error, @data) =>
@createDefinitions() @createDefinitions()

View file

@ -1 +0,0 @@
.. include:: ../CONTRIBUTING.rst

View file

@ -0,0 +1 @@
.. include:: ../../CONTRIBUTING.rst

View file

@ -1,6 +1,17 @@
Developers
============
.. toctree::
:maxdepth: 1
contributing
switches
api/index
taskoverview
How bootstrap-vz works How bootstrap-vz works
====================== ----------------------
Tasks Tasks
~~~~~ ~~~~~
@ -15,14 +26,14 @@ via attributes. Here is an example:
:: ::
class MapPartitions(Task): class MapPartitions(Task):
description = 'Mapping volume partitions' description = 'Mapping volume partitions'
phase = phases.volume_preparation phase = phases.volume_preparation
predecessors = [PartitionVolume] predecessors = [PartitionVolume]
successors = [filesystem.Format] successors = [filesystem.Format]
@classmethod @classmethod
def run(cls, info): def run(cls, info):
info.volume.partition_map.map(info.volume) info.volume.partition_map.map(info.volume)
In this case the attributes define that the task at hand should run In this case the attributes define that the task at hand should run
after the ``PartitionVolume`` task — i.e. after volume has been after the ``PartitionVolume`` task — i.e. after volume has been

View file

@ -5,11 +5,11 @@ Taskoverview
.. raw:: html .. raw:: html
<svg id="taskoverview-graph"></svg> <svg id="taskoverview-graph"></svg>
<link rel="stylesheet/less" type="text/css" href="_static/taskoverview.less"> <link rel="stylesheet/less" type="text/css" href="../_static/taskoverview.less">
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/less.js/1.5.0/less.min.js"></script> <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/less.js/1.5.0/less.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/coffee-script/1.6.3/coffee-script.min.js"></script> <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/coffee-script/1.6.3/coffee-script.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/d3/3.3.11/d3.js"></script> <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/d3/3.3.11/d3.js"></script>
<script type="text/coffeescript" src="_static/taskoverview.coffee"></script> <script type="text/coffeescript" src="../_static/taskoverview.coffee"></script>
<script type="text/coffeescript"> <script type="text/coffeescript">
overview = new window.TaskOverview selector: '#taskoverview-graph' overview = new window.TaskOverview selector: '#taskoverview-graph'
</script> </script>

View file

@ -1,9 +1,3 @@
.. bootstrap-vz documentation master file, created by
sphinx-quickstart on Sun Mar 23 16:17:28 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
bootstrap-vz bootstrap-vz
============ ============
@ -14,11 +8,6 @@ bootstrap-vz
manifest manifest
providers/index providers/index
plugins/index plugins/index
changelog
api/index
contributing
taskoverview
howitworks
switches
logging logging
changelog
developers/index