Skip to content

Commit

Permalink
Try something.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrood-nrel committed Sep 26, 2024
1 parent 143ec9d commit e235a78
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 17 deletions.
27 changes: 11 additions & 16 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
# 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('.'))
#sys.path.append("../breathe")

# -- General configuration ------------------------------------------------

Expand All @@ -25,20 +29,13 @@
# 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',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
'sphinx.ext.intersphinx',
'sphinxcontrib.bibtex',
]
bibtex_bibfiles = ['references/references.bib']
autodoc_default_flags = ['members','show-inheritance','undoc-members']
autoclass_content = 'both'
mathjax_path = 'https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
numfig = True
extensions = [ 'sphinx.ext.mathjax']


# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
#breathe_projects = {"Nalu-Wind": "../doxygen_output/xml/"}
#breathe_default_project = "Nalu-Wind"

#fortran_src ='../../src/'
#fortran_ext =[' 'F90']
Expand Down Expand Up @@ -350,9 +347,7 @@
#
# texinfo_no_detailmenu = False

primary_domain = "cpp"

def setup(app):
app.add_object_type("inpfile", "inpfile",
objname="Nalu-Wind Input File Parameter",
indextemplate="pair: %s; Nalu-Wind Input File Parameter")
objname="Nalu-Wind input parameter",
indextemplate="pair: %s; Nalu-Wind input parameter")
2 changes: 1 addition & 1 deletion docs/sphinx/source/user/nalu_run/nalu_inp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ Time Integration Options
.. inpfile:: time_int.realms

A list of `realms` names. The names entered here must match
`name` used in the :inpfile:`realms` section. Names listed here not
`name` used in the `realms` section. Names listed here not
found in `realms` list will trigger an error, while realms not
included in this list but present in `realms` will not be
initialized and silently ignored. This can cause the code to abort if the
Expand Down

0 comments on commit e235a78

Please sign in to comment.