FAIRmat-NFDI / nomad-file-parser

84%

develop: 84%

LAST BUILD ON BRANCH docs/setup-mkdocs

branch: docs/setup-mkdocs

CHANGE BRANCH

x

Reset

Sync Branches

• docs/setup-mkdocs
• chore/python-3.13-3.14-ci
• chore/python-3.13-and-upper-cap
• develop
• emit-logs
• extend-parsed-block-visualizer
• fix-metainfo-parser
• fix-text-parser
• improve-parsed-block-visualizer
• parsed-block-visualizer
• perf/textparser-optimizations
• port/chgcar-file-parser
• quantity-precompiled-pattern
• remove-nomad-dependency
• subsection-mdef

Build # 34491764348

Build Type

Pull #18

github

Committed by ndaelman-hu

Commit Message

Integrate module docstrings into a high-level API reference

Replace the API-reference placeholder with a high-level overview
distilled from the in-code docstrings, rather than a full autodoc dump.

- Table of the top-level `nomad_file_parser` exports and their purpose.
- Condensed description of the mapping-parser framework: key components
  (`MappingParser` and its format-specific subclasses, `Mapper`/
  `Transformer`) and the source-to-target conversion pipeline.
- The stable vs. internal API split from the `mapping_parser` module
  docstring, so downstream developers know what is safe to depend on.

Pull Request Pull Request #18: Add documentation and docs infrastructure

Coverage Stats

2382 of 2835 relevant lines covered (84.02%)

2.52 hits per line