Changeset 9dfb1f9 in sasview for docs

Timestamp:

Dec 14, 2014 4:48:13 AM (10 years ago)

Author:

Peter Parker

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

e497527

Parents:

c908b0c

Message:

Refs #221 - Push changes to Sphinx docs. SasView? API code is included, as well as the model_functions file courtesy of Steve.

Location:

docs/sphinx-docs

Files:

• build_sphinx.py (modified) (1 diff)
• source/conf.py (modified) (4 diffs)
• source/dev/dev.rst (added)
• source/index.rst (modified) (1 diff)
• source/user/user.rst (added)

docs/sphinx-docs/build_sphinx.py

@@ -100 +100 @@
 
 if __name__ == "__main__":
-    call()
+    clean()
+    retrieve_user_docs()
+    apidoc()
+    build()

docs/sphinx-docs/source/conf.py

@@ -12 +12 @@
 # serve to show the default.
 
-import sys, os
+import sys, os, collections
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../src'))
+from distutils.util import get_platform
+platform = '.%s-%s'%(get_platform(),sys.version[:3])
+build_lib = os.path.abspath('../../../build/lib'+platform)
+sys.path.insert(0, build_lib)
+print "-- path --"
+print "\n".join(sys.path)
+import sans.sansview
+from sans.sansview import __version__ as sasview_version
+print "version:",sasview_version
 
 # -- General configuration -----------------------------------------------------
@@ -26 +34 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.todo',
+              'sphinx.ext.coverage',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -65 +77 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+#
+# PGP 2014/04/03: We have some code which doesn't get carried over to
+# the build directory.  Exclude the appropriate *.rst files here so
+# that we don't get various "ImportError: No module named ___" when
+# running Sphinx.
+exclude_patterns = ["*sans.perspectives.simulation.rst",
+                    "*sans.pr.c_extensions.rst",
+                    "*sans.realspace.rst",
+                    "*sans.simulation.rst",]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
@@ -169 +189 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'SasViewdoc'
+
+# Turn off permalinks, which are a nice feature for the docs when viewed in a
+# browser, but which look weird (and cannot be "right-click->copy url") in
+# the SasView help.
+html_add_permalinks = ""
 
 

docs/sphinx-docs/source/index.rst

@@ -4 +4 @@
    contain the root `toctree` directive.
 
-SasView documentation
+SasView Documentation
 =====================
 
-Contents:
+.. toctree::
+   :maxdepth: 1
 
-.. toctree::
-   :maxdepth: 2
+   User Documentation <user/user>
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+   Developer Documentation <dev/dev>