Changeset c7e12b6 in sasview for sphinx-docs

Timestamp:

Apr 11, 2012 2:13:26 PM (13 years ago)

Author:

Mathieu Doucet <doucetm@…>

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:

38c05cb

Parents:

8b1d759

Message:

clean up

Location:

sphinx-docs

Files:

• Makefile (moved) (moved from sansmodels/docs/sphinx/Makefile) (2 diffs)
• conf.py (moved) (moved from sansguiframe/docs/sphinx/conf.py) (5 diffs)
• generate_docs.py (added)
• index.rst (moved) (moved from sansdataloader/docs/sphinx/index.rst) (1 diff)

sphinx-docs/Makefile

@@ -6 +6 @@
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../sphinx-docs
 
 # Internal variables.
@@ -41 +41 @@
         python genmods.py
 
-html: stubs
+html: 
         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
         @echo

sphinx-docs/conf.py

@@ -43 +43 @@
 
 # General information about the project.
-project = u'guiframe'
-copyright = u'2010, sans group'
+project = u'SansView'
+copyright = u'2012, SansView Project'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -51 +51 @@
 #
 # The short X.Y version.
-version = '0.1'
+version = '2.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = '2.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -167 +167 @@
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'guiframedoc'
+htmlhelp_basename = 'sansview_docs'
 
 
@@ -181 +181 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'guiframe.tex', u'guiframe Documentation',
-   u'sans group', 'manual'),
+  ('index', 'sansview.tex', u'SansView Documentation',
+   u'SansView Project', 'manual'),
 ]
 
@@ -214 +214 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'guiframe', u'guiframe Documentation',
-     [u'sans group'], 1)
+    ('index', 'sansview', u'SansView Documentation',
+     [u'SansView Project'], 1)
 ]

sphinx-docs/index.rst

@@ -4 +4 @@
    contain the root `toctree` directive.
 
-Welcome to DataLoader's documentation!
+SansView documentation
 ======================================
 
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-   
-   api/index.rst
-   api/readers/index.rst
 
 Indices and tables