svn rev #24992: trunk/doc/rst_source/

[tsitkova@MIT.EDU]

http://src.mit.edu/fisheye/changelog/krb5/?cs=24992
Commit By: tsitkova
Log Message:
Removed 'viewcode' extension from the conf.py as not-required for the "minimal" build (i.e. build without Complete API and datatype reference section).
Added README file for sphinx-build.




Changed Files:
A   trunk/doc/rst_source/README
U   trunk/doc/rst_source/conf.py
Added: trunk/doc/rst_source/README
===================================================================
--- trunk/doc/rst_source/README	                        (rev 0)
+++ trunk/doc/rst_source/README	2011-06-27 14:49:44 UTC (rev 24992)
@@ -0,0 +1,10 @@
+To build the documentation as HTML pages run:
+
+sphinx-build source_dir  destination_dir
+
+where 
+source_dir is the source directory which includes configuration file conf.py and all source files;
+destination_dir is the directory for the built documentation.
+
+Once completed, the newly generated HTML documentation can be viewed from the browser by pointing to destination_dir/index.html
+

Modified: trunk/doc/rst_source/conf.py
===================================================================
--- trunk/doc/rst_source/conf.py	2011-06-26 14:28:26 UTC (rev 24991)
+++ trunk/doc/rst_source/conf.py	2011-06-27 14:49:44 UTC (rev 24992)
@@ -26,7 +26,7 @@
 # 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', 'sphinxcontrib.doxylink']
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc']
 
 
 # Add any paths that contain templates here, relative to this directory.