docs: full Doxygen API documentation for CIF handling#415
Merged
Conversation
added 10 commits
April 22, 2026 14:07
Wires up Doxygen XML generation + Breathe Sphinx extension so that C++ API documentation from header comments renders in the existing Sphinx/readthedocs site at docs/api.rst. - docs/Doxyfile: Doxygen config (XML-only output, internal headers excluded) - docs/conf.py: runs Doxygen as subprocess, adds breathe extension - docs/api.rst: stub C++ API reference page (expanded by subsequent PRs) - docs/index.rst: replace external cxx-api link with internal api.rst - docs/requirements.txt: add breathe >= 4.35 - .readthedocs.yaml: add apt_packages: [doxygen] - .gitignore: exclude docs/_doxygen/ (generated) Builds on prior work in project-gemmi#402 (Paul Emsley / pemsley). Co-authored-by: C. Vonrhein / CV-GPhL
This was referenced Apr 22, 2026
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds complete Doxygen API documentation for Gemmi's CIF (Crystallographic Information File) handling layer, covering 8 headers:
cifdoc.hpp— core CIF document model (Document, Block, Loop, Item, Column)cif.hpp— CIF parsing entry points (read_file, read_string, read_memory)read_cif.hpp— CIF reading with path/stream/memory overloadsto_cif.hpp— CIF writing (WriteOptions, write_cif_block_to_stream, write_cif_to_file)to_json.hpp— CIF-to-JSON conversion (JsonWriteOptions, write_as_json, write_as_mmjson)json.hpp— CIF document reading from JSON (cif_document_from_json)numb.hpp— CIF number parsing utilities (as_number, as_int, is_numb)ddl.hpp— DDL1/DDL2 dictionary validation (Validator, validate)Documentation standard
///triple-slash Doxygen comments throughout@brief; non-obvious parameters have@param/@return/@throwsDependencies
This PR depends on PR #413 (Doxygen/Breathe infrastructure) being merged first.
It follows PR #414 (core data structures) in the documentation series.
Series context
This is PR 3 of a planned series of 10 PRs adding incremental API documentation:
api-docs/infraapi-docs/core-structuresapi-docs/cifapi-docs/structure-ioapi-docs/reflectionapi-docs/maps-gridsapi-docs/calculationsapi-docs/chemistryapi-docs/scattering-mathapi-docs/io-utilsAttribution
Builds on and credits prior work in PR #402 (Paul Emsley / pemsley). All comments audited/rewritten where needed against actual implementations.