From 188672404bb90dc965e2dd3691566d0e623ff9c7 Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Sun, 12 Apr 2015 15:12:37 +0200 Subject: [PATCH] Move developer doc stuff into developers/ subfolder --- README.rst | 6 ++--- docs/_static/taskoverview.coffee | 2 +- docs/contributing.rst | 1 - docs/{ => developers}/api/base/fs.rst | 0 docs/{ => developers}/api/base/index.rst | 0 docs/{ => developers}/api/base/pkg.rst | 0 docs/{ => developers}/api/common/fs.rst | 0 docs/{ => developers}/api/common/index.rst | 0 .../api/common/tasks/index.rst | 0 docs/{ => developers}/api/index.rst | 0 docs/developers/contributing.rst | 1 + docs/{howitworks.rst => developers/index.rst} | 27 +++++++++++++------ docs/{ => developers}/switches.rst | 0 docs/{ => developers}/taskoverview.rst | 4 +-- docs/index.rst | 15 ++--------- 15 files changed, 28 insertions(+), 28 deletions(-) delete mode 100644 docs/contributing.rst rename docs/{ => developers}/api/base/fs.rst (100%) rename docs/{ => developers}/api/base/index.rst (100%) rename docs/{ => developers}/api/base/pkg.rst (100%) rename docs/{ => developers}/api/common/fs.rst (100%) rename docs/{ => developers}/api/common/index.rst (100%) rename docs/{ => developers}/api/common/tasks/index.rst (100%) rename docs/{ => developers}/api/index.rst (100%) create mode 100644 docs/developers/contributing.rst rename docs/{howitworks.rst => developers/index.rst} (80%) rename docs/{ => developers}/switches.rst (100%) rename docs/{ => developers}/taskoverview.rst (76%) diff --git a/README.rst b/README.rst index 1e08507..ac2ce78 100644 --- a/README.rst +++ b/README.rst @@ -136,13 +136,13 @@ Developers The API documentation, development guidelines and an explanation of bootstrap-vz internals can be found at -`bootstrap-vz.readthedocs.org `__. +`bootstrap-vz.readthedocs.org `__. Contributing ------------ Contribution guidelines are described in the documentation under -`Contributing `__. +`Contributing `__. There's also -`a topic `__ +`a topic `__ regarding the coding style. diff --git a/docs/_static/taskoverview.coffee b/docs/_static/taskoverview.coffee index ccae87d..f4e1f25 100644 --- a/docs/_static/taskoverview.coffee +++ b/docs/_static/taskoverview.coffee @@ -26,7 +26,7 @@ class window.TaskOverview constructor: ({@selector}) -> @svg = d3.select(@selector) .attr('viewBox', "0 0 #{viewBoxWidth} #{viewBoxHeight}") - d3.json '_static/graph.json', @buildGraph + d3.json '../_static/graph.json', @buildGraph buildGraph: (error, @data) => @createDefinitions() diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/api/base/fs.rst b/docs/developers/api/base/fs.rst similarity index 100% rename from docs/api/base/fs.rst rename to docs/developers/api/base/fs.rst diff --git a/docs/api/base/index.rst b/docs/developers/api/base/index.rst similarity index 100% rename from docs/api/base/index.rst rename to docs/developers/api/base/index.rst diff --git a/docs/api/base/pkg.rst b/docs/developers/api/base/pkg.rst similarity index 100% rename from docs/api/base/pkg.rst rename to docs/developers/api/base/pkg.rst diff --git a/docs/api/common/fs.rst b/docs/developers/api/common/fs.rst similarity index 100% rename from docs/api/common/fs.rst rename to docs/developers/api/common/fs.rst diff --git a/docs/api/common/index.rst b/docs/developers/api/common/index.rst similarity index 100% rename from docs/api/common/index.rst rename to docs/developers/api/common/index.rst diff --git a/docs/api/common/tasks/index.rst b/docs/developers/api/common/tasks/index.rst similarity index 100% rename from docs/api/common/tasks/index.rst rename to docs/developers/api/common/tasks/index.rst diff --git a/docs/api/index.rst b/docs/developers/api/index.rst similarity index 100% rename from docs/api/index.rst rename to docs/developers/api/index.rst diff --git a/docs/developers/contributing.rst b/docs/developers/contributing.rst new file mode 100644 index 0000000..ac7b6bc --- /dev/null +++ b/docs/developers/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../CONTRIBUTING.rst diff --git a/docs/howitworks.rst b/docs/developers/index.rst similarity index 80% rename from docs/howitworks.rst rename to docs/developers/index.rst index cca75c9..5f1cdea 100644 --- a/docs/howitworks.rst +++ b/docs/developers/index.rst @@ -1,6 +1,17 @@ +Developers +============ + +.. toctree:: + :maxdepth: 1 + + contributing + switches + api/index + taskoverview + How bootstrap-vz works -====================== +---------------------- Tasks ~~~~~ @@ -15,14 +26,14 @@ via attributes. Here is an example: :: class MapPartitions(Task): - description = 'Mapping volume partitions' - phase = phases.volume_preparation - predecessors = [PartitionVolume] - successors = [filesystem.Format] + description = 'Mapping volume partitions' + phase = phases.volume_preparation + predecessors = [PartitionVolume] + successors = [filesystem.Format] - @classmethod - def run(cls, info): - info.volume.partition_map.map(info.volume) + @classmethod + def run(cls, info): + info.volume.partition_map.map(info.volume) In this case the attributes define that the task at hand should run after the ``PartitionVolume`` task — i.e. after volume has been diff --git a/docs/switches.rst b/docs/developers/switches.rst similarity index 100% rename from docs/switches.rst rename to docs/developers/switches.rst diff --git a/docs/taskoverview.rst b/docs/developers/taskoverview.rst similarity index 76% rename from docs/taskoverview.rst rename to docs/developers/taskoverview.rst index e84680e..2e76e19 100644 --- a/docs/taskoverview.rst +++ b/docs/developers/taskoverview.rst @@ -5,11 +5,11 @@ Taskoverview .. raw:: html - + - + diff --git a/docs/index.rst b/docs/index.rst index f10ebe0..4056a36 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 ============ @@ -14,11 +8,6 @@ bootstrap-vz manifest providers/index plugins/index - changelog - - api/index - contributing - taskoverview - howitworks - switches logging + changelog + developers/index