diff --git a/Makefile b/Makefile index 76e73bf5df..e3e106e851 100644 --- a/Makefile +++ b/Makefile @@ -14,7 +14,7 @@ subdirs: $(SUBDIRS) #$(SUBDIRS): # $(MAKE) -C $@ -manual :: +manual :: nxdl2rst $(MAKE) html -C $@ impatient-guide :: @@ -26,6 +26,9 @@ impatient-guide :: clean: $(MAKE) clean -C $(SUBDIRS) +nxdl2rst: + $(MAKE) -C manual/source + builddir :: mkdir -p build python utils/build_preparation.py . build diff --git a/manual/Makefile b/manual/Makefile old mode 100755 new mode 100644 index 7a6a7ae0fc..191add6df9 --- a/manual/Makefile +++ b/manual/Makefile @@ -1,154 +1,20 @@ -# Makefile for Sphinx documentation +# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -PAPER = +SPHINXPROJ = NeXusManual +SOURCEDIR = source 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 - -SUBDIRS = source - -.PHONY: help clean html dirhtml singlehtml \ - pickle json htmlhelp qthelp devhelp \ - epub latex latexpdf text man changes \ - linkcheck doctest subdirs $(SUBDIRS) \ - rebuild - - +# Put it first so that "make" without argument is like "make help". 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)/doctrees $(BUILDDIR)/latex - $(MAKE) clean -C $(SUBDIRS) - -subdirs: $(SUBDIRS) - -$(SUBDIRS): - $(MAKE) -C $@ - -rebuild :: realclean complete - -realclean: - -rm -rf $(BUILDDIR)/* - $(MAKE) clean -C $(SUBDIRS) - -complete: latexpdf html - @echo - @echo "Build finished. The HTML and PDF documents are in $(BUILDDIR)/html." - -html: subdirs - $(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/NeXusacommondataformatforneutronx-rayandmuonscience.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NeXusacommondataformatforneutronx-rayandmuonscience.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/NeXusacommondataformatforneutronx-rayandmuonscience" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NeXusacommondataformatforneutronx-rayandmuonscience" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - -cp -f $(BUILDDIR)/epub/*.epub $(BUILDDIR)/../source - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: subdirs - $(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: latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - -cp -f $(BUILDDIR)/latex/*.pdf $(BUILDDIR)/../source - @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." + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -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." +.PHONY: help Makefile -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/manual/source/conf.py b/manual/source/conf.py index 5091fc581e..d55d98531b 100755 --- a/manual/source/conf.py +++ b/manual/source/conf.py @@ -1,286 +1,202 @@ # -*- coding: utf-8 -*- # -# NeXus: User Guide and Reference Documentation build configuration file, created by -# sphinx-quickstart on Wed May 18 12:57:35 2011. +# NeXus: User Guide and Reference Documentation build configuration file # -# 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. +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- import sys, os, datetime # 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('.')) +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + -# -- General configuration ----------------------------------------------------- +# -- Project information ----------------------------------------------------- + +project = u'nexus' +author = u'NIAC, https://nexusformat.org' +copyright = u'1996-{}, {}'.format(datetime.datetime.now().year, author) +# description = u'One line description of project.' +description = u'NeXus: A Common Data Format for Neutron, X-ray, and Muon Science' + +# The short X.Y version +version = u'unknown NXDL version' +release = u'unknown NXDL release' +nxdl_version = open('../../NXDL_VERSION').read().strip() +if nxdl_version is not None: + version = nxdl_version.split('.')[0] + release = nxdl_version + + +# -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' needs_sphinx = '1.1' # the :index: role debuted in v1.1 -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] -#extensions.append( 'sphinx.ext.imgmath' ) -#extensions.append( 'sphinx.ext.pngmath' ) -extensions.append( 'sphinx.ext.mathjax' ) -extensions.append( 'sphinx.ext.ifconfig' ) -extensions.append( 'sphinx.ext.todo' ) -extensions.append( 'sphinx.ext.viewcode' ) +# 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.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix of source filenames. +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] source_suffix = '.rst' -# The encoding of source files. -#source_encoding = 'utf-8-sig' -#source_encoding = 'ISO-8859-1' - # The master toctree document. master_doc = 'index' -# General information about the project. -project = u'NeXus: Manual' -copyright = u'1996-%d, http://nexusformat.org' % datetime.datetime.now().year - -# 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. -# - -nxdl_version = open('../../NXDL_VERSION').read().strip() -if nxdl_version is not None: - version = nxdl_version.split('.')[0] - release = nxdl_version - - # 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' -today_fmt = '%Y-%m-%d %H:%M:%S %Z' +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . 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 --------------------------------------------------- +# -- 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' +# +# html_theme = 'alabaster' html_theme = 'sphinxdoc' -#html_theme = 'agogo' # 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 -html_logo = "nexuslogo.png" - -# 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 +# +# html_theme_options = {} # 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' -html_last_updated_fmt = today_fmt - -# 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. +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} html_sidebars = { - '**': ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html', 'google_search.html'], + '**': [ + 'localtoc.html', + 'relations.html', + 'sourcelink.html', + 'searchbox.html', + 'google_search.html' + ], } -# 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 +# -- Options for HTMLHelp output --------------------------------------------- -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# Output file base name for HTML help builder. +htmlhelp_basename = 'NeXusManualdoc' -# 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 = '' +# -- Options for LaTeX output ------------------------------------------------ -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + 'papersize': 'letterpaper', -# Output file base name for HTML help builder. -htmlhelp_basename = 'nexus' + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', -# -- Options for LaTeX output -------------------------------------------------- + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' + 'maxlistdepth': 10, +} -# The font size ('10pt', '11pt' or '12pt'). -latex_font_size = '11pt' -latex_font_size = '10pt' +latex_logo = "nexuslogo.png" # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'nexus.tex', u'NeXus: A Common Data Format for Neutron, X-ray, and Muon Science', - 'NeXus International Advisory Committee\\\\\hfill{}nexus@nexusformat.org\\\\\hfill{}http://nexusformat.org', 'manual'), + ( + master_doc, + project + '.tex'.lower(), + project + u' Documentation', + # author: 'NeXus International Advisory Committee\\\\\hfill{}nexus@nexusformat.org\\\\\hfill{}http://nexusformat.org' + author, + 'manual' + ), ] -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None -latex_logo = "nexuslogo.png" - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -latex_use_parts = False -#latex_use_parts = True - -# If true, show page references after internal links. -#latex_show_pagerefs = False -#latex_show_pagerefs = True - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble_text. -preamble_text = ''' -% 2012-09-25,PRJ: #240 temporary diagnostic -\\listfiles -% when done, remove referencing from index.rst and cp from Makefile: latexpdf -\usepackage{enumitem} -\setlistdepth{9} -''' -latex_elements = { - 'preamble_text': preamble_text, # the new way - 'maxlistdepth': 10, # deeply nested application definitions -} -#latex_preamble = preamble_text # the old way - -# 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 -------------------------------------------- +# -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'nexus', u'NeXus: User Guide and Reference Documentation', - [u'http://nexusformat.org'], 1) + ( + master_doc, + project.lower(), + project + u' Documentation', + [author], + 1 + ) ] -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'NeXus: User Guide and Reference Documentation' -epub_author = u'http://nexusformat.org' -epub_publisher = u'http://nexusformat.org' -epub_copyright = unicode(copyright) - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + project, + author, + author, + project, + description, + 'Miscellaneous' + ), +] -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 -# Allow duplicate toc entries. -#epub_tocdup = True +# -- Extension configuration -------------------------------------------------