From 48bb9653e83905fdb5bcda0604516e8b5e6de84b Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Fri, 13 May 2011 23:21:38 -0700 Subject: [PATCH] merge testing manual with regular manual --- doc/manual/Makefile | 2 +- .../source/how-to-write-tests.rst | 0 doc/manual/source/index.rst | 15 +- .../source/test-background.rst} | 0 .../source/test-framework.rst} | 0 .../source/test-overview.rst} | 0 doc/manual/source/tests.rst | 9 + doc/models/source/index.rst | 6 +- doc/testing/Makefile | 154 ------------- doc/testing/pickle-to-xml.py | 42 ---- doc/testing/source/_static/.hidden | 0 doc/testing/source/conf.py | 216 ------------------ doc/testing/source/index.rst | 23 -- doc/testing/source/replace.txt | 3 - 14 files changed, 21 insertions(+), 449 deletions(-) rename doc/{testing => manual}/source/how-to-write-tests.rst (100%) rename doc/{testing/source/background.rst => manual/source/test-background.rst} (100%) rename doc/{testing/source/testing-framework.rst => manual/source/test-framework.rst} (100%) rename doc/{testing/source/overview.rst => manual/source/test-overview.rst} (100%) create mode 100644 doc/manual/source/tests.rst delete mode 100644 doc/testing/Makefile delete mode 100755 doc/testing/pickle-to-xml.py delete mode 100644 doc/testing/source/_static/.hidden delete mode 100644 doc/testing/source/conf.py delete mode 100644 doc/testing/source/index.rst delete mode 100644 doc/testing/source/replace.txt diff --git a/doc/manual/Makefile b/doc/manual/Makefile index e8c6310cc..c4b063e25 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -53,7 +53,7 @@ help: @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: - -rm -rf $(BUILDDIR)/* + -rm -rf $(BUILDDIR) -rm -rf $(IMAGES) frag: pickle diff --git a/doc/testing/source/how-to-write-tests.rst b/doc/manual/source/how-to-write-tests.rst similarity index 100% rename from doc/testing/source/how-to-write-tests.rst rename to doc/manual/source/how-to-write-tests.rst diff --git a/doc/manual/source/index.rst b/doc/manual/source/index.rst index e2322a527..aa235cfb4 100644 --- a/doc/manual/source/index.rst +++ b/doc/manual/source/index.rst @@ -1,15 +1,16 @@ .. only:: html or latex -Welcome to ns-3's manual! -========================= +ns-3 Manual +=========== -This is the *ns-3 manual*. Primary documentation for the ns-3 project is -available in four forms: +This is the *ns-3 Manual*. Primary documentation for the ns-3 project is +available in five forms: * `ns-3 Doxygen `_: Documentation of the public APIs of the simulator * `Tutorial `_ -* `Reference Manual `_: *(this document)* -* `ns-3 wiki `_ +* `Manual `_: *(this document)* +* `Model Library `_ +* `ns-3 wiki `_ This document is written in `reStructuredText `_ for `Sphinx `_ and is maintained in the ``doc/manual`` directory of ns-3's source code. @@ -26,7 +27,7 @@ This document is written in `reStructuredText `_: Documentation of the public APIs of the simulator * `Tutorial `_ -* `Developers Manual `_ +* `Manual `_ * `Model Library `_: *(this document)* * `ns-3 wiki `_ diff --git a/doc/testing/Makefile b/doc/testing/Makefile deleted file mode 100644 index 215b27606..000000000 --- a/doc/testing/Makefile +++ /dev/null @@ -1,154 +0,0 @@ -EPSTOPDF = epstopdf -DIA = dia -CONVERT = convert - -FIGURES = figures -VPATH = $(FIGURES) - -IMAGES_EPS = \ - -IMAGES_PNG = ${IMAGES_EPS:.eps=.png} -IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf} - -IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF) - -%.eps : %.dia; $(DIA) -t eps $< -e $@ -%.png : %.dia; $(DIA) -t png $< -e $@ -%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi - - -# 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) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where 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)/* - -rm -rf $(IMAGES) - -frag: pickle - @if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi - pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle > navigation.xml && popd - cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag - -html: $(IMAGES) - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: $(IMAGES) - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: $(IMAGES) - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: $(IMAGES) - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: $(IMAGES) - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: $(IMAGES) - $(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: $(IMAGES) - $(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/ns-3.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc" - -devhelp: $(IMAGES) - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ns-3" - @echo "# devhelp" - -epub: $(IMAGES) - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: $(IMAGES) - $(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: $(IMAGES) - $(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: $(IMAGES) - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: $(IMAGES) - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: $(IMAGES) - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: $(IMAGEs) - $(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: $(IMAGES) - $(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/doc/testing/pickle-to-xml.py b/doc/testing/pickle-to-xml.py deleted file mode 100755 index be3126cf6..000000000 --- a/doc/testing/pickle-to-xml.py +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/python - - -# output xml format: -# -# zzzlllfile.frag -# ... -# - -import pickle -import os -import codecs - -def dump_pickles(out, dirname, filename, path): - f = open(os.path.join(dirname, filename), 'r') - data = pickle.load(f) - fragment_file = codecs.open(data['current_page_name'] + '.frag', mode='w', encoding='utf-8') - fragment_file.write(data['body']) - fragment_file.close() - out.write(' \n' % path) - out.write(' %s.frag\n' % data['current_page_name']) - if data['prev'] is not None: - out.write(' %s\n' % - (os.path.normpath(os.path.join(path, data['prev']['link'])), - data['prev']['title'])) - if data['next'] is not None: - out.write(' %s\n' % - (os.path.normpath(os.path.join(path, data['next']['link'])), - data['next']['title'])) - out.write(' \n') - f.close() - if data['next'] is not None: - next_path = os.path.normpath(os.path.join(path, data['next']['link'])) - next_filename = os.path.basename(next_path) + '.fpickle' - dump_pickles(out, dirname, next_filename, next_path) - return - -import sys - -sys.stdout.write('\n') -dump_pickles(sys.stdout, os.path.dirname(sys.argv[1]), os.path.basename(sys.argv[1]), '/') -sys.stdout.write('') diff --git a/doc/testing/source/_static/.hidden b/doc/testing/source/_static/.hidden deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/testing/source/conf.py b/doc/testing/source/conf.py deleted file mode 100644 index 0521b3ce5..000000000 --- a/doc/testing/source/conf.py +++ /dev/null @@ -1,216 +0,0 @@ -# -*- coding: utf-8 -*- -# -# ns-3 documentation build configuration file, created by -# sphinx-quickstart on Tue Dec 14 09:00:39 2010. -# -# 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 ----------------------------------------------------- - -# 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.pngmath'] - -# 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'ns-3' -copyright = u'2010, ns-3 project' - -# 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 = 'ns-3.10' -# The full version, including alpha/beta/rc tags. -release = 'ns-3.10' - -# 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 = [] - -# 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 -# " v 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 = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a 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 = 'ns-3doc' - - -# -- 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', 'ns-3.tex', u'ns-3 Testing and Validation', - u'ns-3 project', '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', 'ns-3', u'ns-3 Documentation', - [u'ns-3 project'], 1) -] diff --git a/doc/testing/source/index.rst b/doc/testing/source/index.rst deleted file mode 100644 index 2a9c64011..000000000 --- a/doc/testing/source/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. only:: html or latex - -Welcome to ns-3's testing and validation documentation! -======================================================= - -This is the *ns-3 testing manual*. Primary documentation for the ns-3 project is -available in four forms: - -* `ns-3 Doxygen `_: Documentation of the public APIs of the simulator -* `Tutorial `_ -* `Reference Manual `_ -* `ns-3 wiki `_ - -This document is written in `reStructuredText `_ for `Sphinx `_ and is maintained in the -``doc/testing`` directory of ns-3's source code. - -.. toctree:: - :maxdepth: 2 - - overview - background - testing-framework - how-to-write-tests diff --git a/doc/testing/source/replace.txt b/doc/testing/source/replace.txt deleted file mode 100644 index 4cb2f2303..000000000 --- a/doc/testing/source/replace.txt +++ /dev/null @@ -1,3 +0,0 @@ -.. |ns3| replace:: *ns-3* - -.. |ns2| replace:: *ns-2*