Changeset 488 for topdoc

Timestamp:

Apr 10, 2011 11:34:11 AM (14 years ago)

Author:

jemian

Message:

PYTHONPATH should be modified in conf.py, relative to its directory

Location:

topdoc/doc

Files:

• Makefile (modified) (1 diff, 1 prop)
• make-clean.bat (modified) (1 prop)
• make-html.bat (modified) (1 prop)
• make.bat (modified) (1 prop)
• setpath.csh (deleted)
• setpath.sh (deleted)
• source/TopDoc/CmdReader.rst (modified) (1 diff, 2 props)
• source/TopDoc/CommandTable.rst (modified) (1 diff, 2 props)
• source/TopDoc/EpicsDatabase.rst (modified) (1 diff, 2 props)
• source/TopDoc/EpicsTemplate.rst (modified) (1 diff, 2 props)
• source/TopDoc/SymbolTable.rst (modified) (1 diff, 2 props)
• source/TopDoc/TokenLog.rst (modified) (1 diff, 2 props)
• source/TopDoc/TopDoc.rst (modified) (1 diff, 2 props)
• source/TopDoc/Trove.rst (modified) (1 diff, 2 props)
• source/TopDoc/utilities.rst (modified) (1 diff, 2 props)
• source/TopDoc/xmlTools.rst (modified) (1 diff, 2 props)
• source/conf.py (modified) (1 diff)
• source/discover/build_config.rst (modified) (1 diff, 2 props)
• source/discover/vespucci.rst (modified) (2 diffs, 2 props)
• source/index.rst (modified) (1 diff, 2 props)

topdoc/doc/Makefile ¶

@@ -5 +5 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-PAPER         =
+PAPER         = letter
 BUILDDIR      = build
 

topdoc/doc/source/TopDoc/CmdReader.rst ¶

@@ -1 @@
-
 --------------------------
 CmdReader
 --------------------------
 
-.. automodule:: CmdReader
+.. automodule:: TopDoc.CmdReader
      :synopsis: parses EPICS IOC startup command files
      :members:

topdoc/doc/source/TopDoc/CommandTable.rst ¶

@@ -1 @@
-
 --------------------------
 CommandTable
 --------------------------
 
-.. automodule:: CommandTable
+.. automodule:: TopDoc.CommandTable
      :synopsis: global command list
      :members:

topdoc/doc/source/TopDoc/EpicsDatabase.rst ¶

@@ -1 @@
-
 --------------------------
 EpicsDatabase
 --------------------------
 
-.. automodule:: EpicsDatabase
+.. automodule:: TopDoc.EpicsDatabase
      :synopsis: reads an EPICS database file
      :members:

topdoc/doc/source/TopDoc/EpicsTemplate.rst ¶

@@ -1 @@
-
 --------------------------
 EpicsTemplate
 --------------------------
 
-.. automodule:: EpicsTemplate
+.. automodule:: TopDoc.EpicsTemplate
      :synopsis: reads an EPICS template (substitutions) file
      :members:

topdoc/doc/source/TopDoc/SymbolTable.rst ¶

@@ -1 @@
-
 --------------------------
 SymbolTable
 --------------------------
 
-.. automodule:: SymbolTable
+.. automodule:: TopDoc.SymbolTable
      :synopsis: global symbol table
      :members:

topdoc/doc/source/TopDoc/TokenLog.rst ¶

@@ -1 @@
-
 --------------------------
 TokenLog
 --------------------------
 
-.. automodule:: TokenLog
+.. automodule:: TopDoc.TokenLog
      :synopsis: Applies Python :mod:`tokenize` analysis to each line of a file.
      :members:

topdoc/doc/source/TopDoc/TopDoc.rst ¶

@@ -1 @@
-
 --------------------------
 TopDoc
 --------------------------
 
-.. automodule:: TopDoc
+.. automodule:: TopDoc.TopDoc
      :synopsis: autogenerates documentation of EPICS IOCs
      :members:

topdoc/doc/source/TopDoc/Trove.rst ¶

@@ -1 @@
-
 --------------------------
 Trove
 --------------------------
 
-.. automodule:: Trove
+.. automodule:: TopDoc.Trove
      :synopsis: items discovered and collected while analyzing an EPICS IOC's startup files
      :members:

topdoc/doc/source/TopDoc/utilities.rst ¶

@@ -1 @@
-
 --------------------------
 utilities
 --------------------------
 
-.. automodule:: utilities
+.. automodule:: TopDoc.utilities
      :synopsis: utility routines
      :members:

topdoc/doc/source/TopDoc/xmlTools.rst ¶

@@ -1 @@
-
 --------------------------
 xmlTools
 --------------------------
 
-.. automodule:: xmlTools
+.. automodule:: TopDoc.xmlTools
      :synopsis: Support for XML files
      :members:

topdoc/doc/source/conf.py ¶

@@ -18 +18 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
+#
+# relative to directory with conf.py
+sys.path.insert(0, os.path.abspath('../../src'))
 
 # -- General configuration -----------------------------------------------------

topdoc/doc/source/discover/build_config.rst ¶

@@ -1 @@
-
 --------------------------
 build_config
 --------------------------
 
-.. automodule:: build_config
-     :synopsis: builds config.xml for use by :mod:`TopDoc`
+Writes a `config.xml` file using selected IOCs.
+All the input for :mod:'build_config' is contained
+within the source code.  This works for now but should 
+be streamlined with :mod:'vespucci'.
+
+.. automodule:: discover.build_config
+     :synopsis: builds `config.xml for use by :mod:'TopDoc'
      :members:

topdoc/doc/source/discover/vespucci.rst ¶

@@ -1 @@
-
 --------------------------
 vespucci
@@ -18 +17 @@
 
 
-.. automodule:: vespucci
+.. automodule:: discover.vespucci
      :synopsis: walks XSD file server looking for IOC boot directories
      :members:

topdoc/doc/source/index.rst ¶

@@ -60 +60 @@
 * :ref:`modindex`
 * :ref:`search`
-