Reorganize MLIP base class documentation into dedicated guide #885
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.
Addressed review feedback to improve documentation structure for MLIP base classes.
Changes
docs/src/dev-docs/new-mlip.rst: New dedicated guide for adding MLIP-only architectures, moved from inline example innew-architecture.rstdocs/src/dev-docs/utils/mlip.rst: Reduced to automodule directive only (lines 1-7)MLIPModelandMLIPTrainer: Moved all documentation content into class docstrings, including:examples/0-beginner/00-basic-usage.sh: Restored original:ref:tutorials`` referenceThe new structure separates the high-level "how to add an MLIP architecture" guide from the API reference, making both easier to find and use.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.