From e9c1c57a9c4d8b14c04d1534c5520f63a0a5b311 Mon Sep 17 00:00:00 2001 From: Zhanna Tsitkov Date: Mon, 27 Jun 2011 14:49:44 +0000 Subject: [PATCH] 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. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24992 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/rst_source/README | 10 ++++++++++ doc/rst_source/conf.py | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/rst_source/README diff --git a/doc/rst_source/README b/doc/rst_source/README new file mode 100644 index 000000000..63d13461f --- /dev/null +++ b/doc/rst_source/README @@ -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 + diff --git a/doc/rst_source/conf.py b/doc/rst_source/conf.py index 7baea4066..4e6a1e0c8 100644 --- a/doc/rst_source/conf.py +++ b/doc/rst_source/conf.py @@ -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. -- 2.26.2