New structure for the docs

markgw · Apr 5, 2016 · 011861c · 011861c
1 parent 4fc80c3
commit 011861c
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 4 deletions.
diff --git a/docs/api/intro.rst b/docs/api/intro.rst
diff --git a/docs/core/intro.rst b/docs/core/intro.rst
@@ -0,0 +1,10 @@
+=================
+Core Pimlico docs
+=================
+
+A set of articles on the core aspects and features of Pimlico .
+
+.. toctree::
+   maxdepth: 2
+
+   variants
diff --git a/docs/variants.rst → docs/core/variants.rst b/docs/variants.rst → docs/core/variants.rst
diff --git a/docs/guides/intro.rst b/docs/guides/intro.rst
@@ -0,0 +1,10 @@
+==============
+Pimlico guides
+==============
+
+Step by step guides through common tasks while using Pimlico.
+
+.. toctree::
+:maxdepth: 2
+
+       setup
diff --git a/docs/setup_guide.rst → docs/guides/setup.rst b/docs/setup_guide.rst → docs/guides/setup.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,18 +27,18 @@ pipeline and checking that everything's executed in the right order.
      adding these more of less as I need them and am keen to accept contributions 
      of wrappers if you develop them for your own pipelines
    - there are some key features missing, which I'll add as time goes on. 
-     See :doc:`my wishlist <wishlist>` for things that I'm currently planning to 
+     See :doc:`my wishlist <plans/wishlist>` for things that I'm currently planning to
      add.
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   core/intro
+   guides/intro
+   plans/wishlist
 
-Guides
-======
-* :doc:`setup_guide`
 
 Indices and tables
 ==================

diff --git a/docs/wishlist.rst → docs/plans/wishlist.rst b/docs/wishlist.rst → docs/plans/wishlist.rst