Restructure the reference documentation:

- draw NAPI docs out of core reference (because of frozen status, and for clearer overall structure) - explain basics of base classes and applicn defs before introducing NXDL - move class definition chapters to second level (for easier browsing in HTML, and for clearer structure in the PDF version)
nexusformat · Aug 18, 2014 · 8565bda · 8565bda
1 parent 713a937
commit 8565bda
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 17 deletions.
diff --git a/manual/source/classes/index.rst → manual/source/defs_intro.rst b/manual/source/classes/index.rst → manual/source/defs_intro.rst
@@ -1,8 +1,8 @@
 .. _ClassDefinitions:
 
-=======================
-NeXus class definitions
-=======================
+=================================
+Introduction to NeXus definitions
+=================================
 
 ..
 	.. image:: img/NeXus.png
@@ -29,13 +29,5 @@ NeXus Class Specifications
 .. toctree::
 	:maxdepth: 1
 
-	overview
-
-.. rubric:: Descriptions of the NeXus classes
-
-.. toctree::
-   :maxdepth: 1
+	defs_overview
 
-   base_classes/index
-   applications/index
-   contributed_definitions/index
diff --git a/manual/source/classes/overview.rst → manual/source/defs_overview.rst b/manual/source/classes/overview.rst → manual/source/defs_overview.rst
diff --git a/manual/source/index.rst b/manual/source/index.rst
@@ -15,6 +15,7 @@ http://www.nexusformat.org/
 
     user_manual
     ref_doc
+    napi
 
 .. toctree::
     :maxdepth: 1

diff --git a/manual/source/napi.rst b/manual/source/napi.rst
@@ -6,9 +6,9 @@
 
 .. _NAPI:
 
-===============================================
-NAPI: NeXus Application Programmer Interface
-===============================================
+=====================================================
+NAPI: NeXus Application Programmer Interface (frozen)
+=====================================================
 
 The Application Program Interface (API) has been developed to facilitate the 
 reading and writing of NeXus files. Those writing applications to produce 

diff --git a/manual/source/ref_doc.rst b/manual/source/ref_doc.rst
@@ -13,7 +13,9 @@ NeXus: Reference Documentation
     :maxdepth: 1
     :glob:
 
-    napi
+    defs_intro
     nxdl
-    classes/index
+    classes/base_classes/index
+    classes/applications/index
+    classes/contributed_definitions/index
     examples/index