Removed 'viewcode' extension from the conf.py as not-required for the "minimal" build...
authorZhanna Tsitkov <tsitkova@mit.edu>
Mon, 27 Jun 2011 14:49:44 +0000 (14:49 +0000)
committerZhanna Tsitkov <tsitkova@mit.edu>
Mon, 27 Jun 2011 14:49:44 +0000 (14:49 +0000)
Added README file for sphinx-build.

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24992 dc483132-0cff-0310-8789-dd5450dbe970

doc/rst_source/README [new file with mode: 0644]
doc/rst_source/conf.py

diff --git a/doc/rst_source/README b/doc/rst_source/README
new file mode 100644 (file)
index 0000000..63d1346
--- /dev/null
@@ -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
+
index 7baea406649dede2d2287eebf8605fbc39e50c4d..4e6a1e0c803763fd15caaef6009e26c729bda498 100644 (file)
@@ -26,7 +26,7 @@ import sys, os
 # 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.