Skip to content

Commit

Permalink
remove docs build of nxdl groupings
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Oct 4, 2024
1 parent 0ab1efb commit d7e03b2
Showing 1 changed file with 2 additions and 36 deletions.
38 changes: 2 additions & 36 deletions dev_tools/docs/nxdl_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,13 @@ def nxdl_indices() -> Dict[str, dict]:
else:
file = ""
print("---------++++++++-", section)
if file.endswith(("applications/index.rst", "base_classes/index.rst")):
rst_lines.append(f"{indentation}em-structure\n")
rst_lines.append(f"{indentation}optical-spectroscopy-structure\n")
rst_lines.append(f"{indentation}mpes-structure\n")
rst_lines.append(f"{indentation}apm-structure\n")

if file.endswith("contributed_definitions/index.rst"):
rst_lines.append(f"{indentation}em-structure\n")
rst_lines.append(f"{indentation}optical-spectroscopy-structure\n")
rst_lines.append(f"{indentation}ellipsometry-structure\n")
rst_lines.append(f"{indentation}mpes-structure\n")
rst_lines.append(f"{indentation}apm-structure\n")
rst_lines.append(f"{indentation}transport-structure\n")
rst_lines.append(f"{indentation}sts-structure\n")
rst_lines.append(f"{indentation}cgms-structure\n")
rst_lines.append(f"{indentation}icme-structure\n")
rst_lines.append(f"{indentation}sample-prep-structure\n")

for cname in sorted(classes):
rst_lines.append(f"{indentation}{cname}\n")
Expand Down Expand Up @@ -119,18 +110,6 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str:
*might* be used in an instance of that class.
Consider the base classes as a set of *components*
that are used to construct a data file.
Some contributions are grouped together:
:ref:`Optical Spectroscopy <Optical-Spectroscopy-Structure-BC>`
:ref:`Multi-dimensional Photoemission Spectroscopy <Mpes-Structure-BC>`
:ref:`Atomprobe Microscopy <Apm-Structure-BC>`
:ref:`Electron Microscopy <Em-Structure-BC>`
and others are simply listed here:
""",
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
"applications": """
Expand Down Expand Up @@ -159,19 +138,6 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str:
In application definitions involving raw data,
write the raw data in the :ref:`NXinstrument` tree and then link to it
from the location(s) defined in the relevant application definition.
Some contributions are grouped together:
:ref:`Optical Spectroscopy <Optical-Spectroscopy-Structure-APP>`
:ref:`Multi-dimensional Photoemission Spectroscopy <Mpes-Structure-APP>`
:ref:`Atomprobe Microscopy <Apm-Structure-APP>`
:ref:`Electron Microscopy <Em-Structure-APP>`
and others are simply listed here:
""",
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
"contributed_definitions": """
Expand All @@ -194,7 +160,7 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str:
and acceptance as either a base class or application definition.
Some contributions are grouped together:
:ref:`Optical Spectroscopy <Optical-Spectroscopy-Structure>`
:ref:`Optical Spectroscopy <Ellipsometry-Structure>`
:ref:`Multi-dimensional Photoemission Spectroscopy <Mpes-Structure>`
Expand Down

0 comments on commit d7e03b2

Please sign in to comment.