[Yum-devel] [PATCH 2/2] This adds configuration files so that Sphinx can automatically generate html documentation for yum. So far, the default settings for Sphinx are mostly used. To generate the documentation, make sure Sphinx is installed, then cd to yum/docs/sphinxdocs and run "make html".

Nick Jacek njacek at redhat.com
Fri Jul 22 19:08:15 UTC 2011


---
 docs/sphinxdocs/Makefile        |  130 ++++++++++++++++++++++
 docs/sphinxdocs/conf.py         |  228 +++++++++++++++++++++++++++++++++++++++
 docs/sphinxdocs/rstgenerator.py |  222 +++++++++++++++++++++++++++++++++++++
 3 files changed, 580 insertions(+), 0 deletions(-)
 create mode 100644 docs/sphinxdocs/Makefile
 create mode 100644 docs/sphinxdocs/conf.py
 create mode 100755 docs/sphinxdocs/rstgenerator.py

diff --git a/docs/sphinxdocs/Makefile b/docs/sphinxdocs/Makefile
new file mode 100644
index 0000000..623c22b
--- /dev/null
+++ b/docs/sphinxdocs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Yum.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Yum.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Yum"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Yum"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/sphinxdocs/conf.py b/docs/sphinxdocs/conf.py
new file mode 100644
index 0000000..b9f2e1d
--- /dev/null
+++ b/docs/sphinxdocs/conf.py
@@ -0,0 +1,228 @@
+# -*- coding: utf-8 -*-
+#
+# Yum documentation build configuration file, created by
+# sphinx-quickstart on Mon Jun 27 14:01:20 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+#Tell sphinx where to look for all the files
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../test")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../po")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../bin")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../..")))
+
+#Generate all the rst files
+sys.path.insert(1, os.getcwd())
+import rstgenerator
+rstgenerator.generateAll(sys.path[0], os.getcwd())
+
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Yum'
+copyright = None
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '3.4'
+# The full version, including alpha/beta/rc tags.
+release = '3.4.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Yumdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Yum.tex', u'Yum Documentation',
+   u'', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'yum', u'Yum Documentation',
+     [u''], 1)
+]
diff --git a/docs/sphinxdocs/rstgenerator.py b/docs/sphinxdocs/rstgenerator.py
new file mode 100755
index 0000000..d2a0ed1
--- /dev/null
+++ b/docs/sphinxdocs/rstgenerator.py
@@ -0,0 +1,222 @@
+#! /usr/bin/python
+
+import sys, re, os
+
+def generateFile(input_directory, file_name, output_directory,
+                 package_heirarchy=None, module_name=None):
+    """Generate a rst file telling sphinx to just generate documentation
+    for the public interface automatically.  Output will be written to
+    *file_name*.rst in the current directory.
+    
+    :param input_directory: a string specifying the directory containing the 
+       source code file
+    :param file_name: the name of the python source code file to generate
+       a sphinx rst file describing
+    :param ouput_directory: a string specifying the directory where
+       the generated rst file should be placed.  If *output_directory* does
+       not already exist, it will be created
+    :param package_heirarchy: a list of strings, where each name is
+       the name of a package, in the order of the hierarchy
+    :param module_name: the name of the module. If not given, the .py is 
+       removed from *file_name* to produce the module_name
+    """
+    #Stick all output into a list of strings, then just join it and output
+    #it all in on go.
+    output = []
+    
+    # Create the output directory if it doesn't already exist. Note that
+    # if the directory is created between the check and the creation, it 
+    # might cause issues, but I don't think this likely at all to happen
+    if not os.path.exists(output_directory):
+        try:
+            os.makedirs(output_directory)
+        except OSError as e:
+            print "Error creating the output directory"
+            print e.args
+
+    try:
+        #Open the file
+        f = open(os.path.join(input_directory, file_name), 'r')
+    
+        #Do the module output
+        if not module_name:
+            module_name = re.search('(\w+).py$', file_name).group(1)
+
+        #Append the package names, if there are any
+        full_module_name = module_name
+        if package_heirarchy:
+            full_module_name = '.'.join(package_heirarchy) + '.' + module_name
+    
+        output.append(full_module_name)
+        output.append('=' * len(full_module_name))
+        output.append('.. automodule:: %s\n' % full_module_name)
+        
+        #Read the file, and do output for classes
+        class_reg = re.compile('^class (\w+)')
+        func_reg = re.compile('^def ((?:[a-zA-Z0-9]+_)*[a-zA-Z0-9]+)')
+        
+        #We don't need a blank line between autofunction directives, but we do
+        #need one between autofunctions and headings etc. for classes.  This
+        #keeps track if we're switching from autofunctions to classes, so we
+        #can add that blank line.
+        finding_functions = False
+        
+        for line in iter(f):
+            #Search for classes
+            match = class_reg.match(line)
+            if match is not None: 
+                if finding_functions:
+                    output.append('')
+                    finding_functions = False
+                class_name = match.group(1)
+                output.append(class_name)
+                output.append('-' * len(class_name))
+                output.append('''.. autoclass:: %s
+           :members:
+           :show-inheritance:
+        
+           ''' % class_name)
+        
+        
+            #Search for top level functions
+            else:
+                match = func_reg.match(line)
+                if match is not None:
+                    func_name = match.group(1)
+                    output.append('.. autofunction:: ' + func_name)
+                    finding_functions = True
+        f.close()
+
+    except IOError as e:
+        print "Error opening the input file : ", os.path.join(input_directory, file_name)
+        print e.args[1]
+
+    else:
+        #Write the output
+        try:
+            output_file_name = os.path.join(output_directory, module_name) + '.rst'
+            f = open(output_file_name, 'w')
+            f.write('\n'.join(output))
+            
+            
+        except IOError as e:
+            print "Error opening the output file : ", output_file_name
+            print e.args[1]
+
+                
+def generateIndex(module_list, output_directory):
+    """Create an index.rst file for sphinx in the given directory.
+
+    :param module_list: a list of the names of the modules to list in
+       the index file
+    :param output_directory: the directory to create the index file in
+    """
+
+    #Sort the module_list
+    module_list.sort()
+
+    try:
+        #open the file
+        f = open(os.path.join(output_directory, 'index.rst'), 'w')
+    
+        #Do the output
+        f.write(""".. Yum documentation master file, created by
+   sphinx-quickstart on Mon Jun 27 14:01:20 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Yum's documentation!
+===============================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   """)
+        f.write('\n   '.join(module_list))
+        f.write("""
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+""")
+
+    except IOError as e:
+        print "Error opening the output file."
+        print e.args[1]
+
+
+def generateAll(source_directory, output_directory):
+    #Verify that both the source and output directories exist
+
+
+    # Keep a set of file names that are packages.  This is 
+    # useful so that later we will be able to figure out full
+    # module names.
+    packages = set()
+
+    # Keep a list of tuples containing python module names and
+    # relative paths, so that we can build the index file later
+    modules = []
+
+    # Walk the directory tree
+    for dirpath, dirnames, filenames in os.walk(source_directory, topdown=True):
+        
+        # print dirpath
+        # print dirnames
+        # print filenames
+        # print
+
+        # Add the curent directory to packages if __init__.py exists
+        if '__init__.py' in filenames:
+            packages.add(dirpath)
+
+        # Find the heirarchy of packages that we are currently in
+        package_heirarchy = []
+        #Recurse up to the root
+        dirpath_i = dirpath
+        while dirpath_i != '/':
+            if dirpath_i in packages:
+                dirpath_i, tail = os.path.split(dirpath_i)
+                package_heirarchy.insert(0, tail)
+            else:
+                break
+
+        # Find the relative output directory, mirroring the input
+        # directory structure
+        relative_output_directory = ''
+        if not os.path.samefile(dirpath, source_directory):
+            relative_output_directory = os.path.relpath(dirpath, source_directory)
+        
+        # Don't recurse into directories that are hidden, or for docs
+        for directory in dirnames:
+            if directory == "docs" or directory.startswith("."):
+                dirnames.remove(directory)
+
+        # Generate the rst for a file if it is a python source code file
+        for file_name in filenames:
+            # Skip file names that contain dashes, since they're not
+            # valid module names, so we won't be able to import them
+            # to generate the documentation anyway
+            if '-' in file_name:
+                continue
+
+            if file_name.endswith('.py'):
+                module_name = file_name.partition('.')[0]
+                modules.append(os.path.join(relative_output_directory, 
+                                            module_name))
+                generateFile(dirpath, file_name, 
+                             os.path.join(output_directory, relative_output_directory),
+                             package_heirarchy, module_name)
+
+        
+    
+    # Create the index.rst file
+    generateIndex(modules, output_directory)
+
+if __name__ == "__main__":
+    generateAll(os.getcwd(), os.getcwd())
-- 
1.7.5.4



More information about the Yum-devel mailing list