Skip to content

Commit

Permalink
short tooltip and link
Browse files Browse the repository at this point in the history
  • Loading branch information
sanbrock committed Jun 15, 2023
1 parent d5faa6b commit 1138ebf
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 2 deletions.
100 changes: 100 additions & 0 deletions build/manual/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'nexus'
author = 'NIAC, https://www.nexusformat.org'
copyright = u'1996-{}, {}'.format(datetime.datetime.now().year, author)
description = u'NeXus: A Common Data Format for Neutron, X-ray, and Muon Science'

# The full version, including alpha/beta/rc tags
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 ---------------------------------------------------

# https://github.com/nexusformat/definitions/issues/659#issuecomment-577438319
needs_sphinx = '2.3'

# 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',
'sphinx.ext.todo',
'sphinx_tabs.tabs'
]

# Show `.. todo` directives in the output
# todo_include_todos = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# 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 = []


# -- 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 = 'alabaster'
html_theme = 'sphinxdoc'

# 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']

# Add extra files
html_extra_path = ['CNAME']

html_sidebars = {
'**': [
'localtoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',
'google_search.html'
],
}

# Output file base name for HTML help builder.
htmlhelp_basename = 'NeXusManualdoc'

# -- Options for Latex output -------------------------------------------------
latex_elements = {
'maxlistdepth':25, # some application definitions are deeply nested
'preamble': r'''
\usepackage{amsbsy}
\usepackage[utf8]{inputenc}'''
}
4 changes: 2 additions & 2 deletions dev_tools/docs/nxdl.py
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ def get_first_parent_ref(self, path, tag):
)
parent_display_name = f"{parent_def_name[1:]}{parent_path}"
return (
f"<:abbr:`parent (parent definition: {parent_display_name})"
+ f"`:ref:`🔗 </{parent_display_name}-{tag}>`>"
f":abbr:`... (override: {parent_display_name})"
+ f"`:ref:`🔗 </{parent_display_name}-{tag}>`"
)
return ""

0 comments on commit 1138ebf

Please sign in to comment.