From 60f63cf5a863e775f14a2fb3e0ce26a5241b1dbc Mon Sep 17 00:00:00 2001 From: Bryan Herman Date: Sat, 14 Mar 2015 08:15:21 -0400 Subject: [PATCH] use the only directive instead of tags for removing Contents from latex doc --- docs/Makefile | 4 ++-- docs/source/conf.py | 9 ++------- docs/source/index.rst | 8 +++++--- docs/source/index_tex.rst | 31 ------------------------------- 4 files changed, 9 insertions(+), 43 deletions(-) delete mode 100644 docs/source/index_tex.rst diff --git a/docs/Makefile b/docs/Makefile index 7e94d2cea9..89c71dc074 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -106,14 +106,14 @@ epub: @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: images - $(SPHINXBUILD) -t latex -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/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: images - $(SPHINXBUILD) -t latex -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + $(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." diff --git a/docs/source/conf.py b/docs/source/conf.py index fe7a0203a4..07651f3e86 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,12 +35,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8' # The master toctree document. -if tags.has('latex'): - master_doc = 'index_tex' - exclude_patterns = ['index.rst'] -else: - master_doc = 'index' - exclude_patterns = ['index_tex.rst'] +master_doc = 'index' # General information about the project. project = u'OpenMC' @@ -189,7 +184,7 @@ htmlhelp_basename = 'openmcdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index_tex', 'openmc.tex', u'OpenMC Documentation', + ('index', 'openmc.tex', u'OpenMC Documentation', u'Massachusetts Institute of Technology', 'manual'), ] diff --git a/docs/source/index.rst b/docs/source/index.rst index 83eac22e0a..7566429403 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,9 +18,11 @@ free to send a message to the User's Group `mailing list`_. .. _Massachusetts Institute of Technology: http://web.mit.edu .. _mailing list: https://groups.google.com/forum/?fromgroups=#!forum/openmc-users --------- -Contents --------- +.. only:: html + + -------- + Contents + -------- .. toctree:: :maxdepth: 1 diff --git a/docs/source/index_tex.rst b/docs/source/index_tex.rst deleted file mode 100644 index d6dffcc4b6..0000000000 --- a/docs/source/index_tex.rst +++ /dev/null @@ -1,31 +0,0 @@ -=========================== -The OpenMC Monte Carlo Code -=========================== - -OpenMC is a Monte Carlo particle transport simulation code focused on neutron -criticality calculations. It is capable of simulating 3D models based on -constructive solid geometry with second-order surfaces. The particle interaction -data is based on ACE format cross sections, also used in the MCNP and Serpent -Monte Carlo codes. - -OpenMC was originally developed by members of the `Computational Reactor Physics -Group`_ at the `Massachusetts Institute of Technology`_ starting -in 2011. Various universities, laboratories, and other organizations now -contribute to the development of OpenMC. For more information on OpenMC, feel -free to send a message to the User's Group `mailing list`_. - -.. _Computational Reactor Physics Group: http://crpg.mit.edu -.. _Massachusetts Institute of Technology: http://web.mit.edu -.. _mailing list: https://groups.google.com/forum/?fromgroups=#!forum/openmc-users - -.. toctree:: - :maxdepth: 1 - - quickinstall - releasenotes/index - methods/index - usersguide/index - devguide/index - publications - license - developers