Skip to content

Allow creating the documentation-only classes#230

Merged
Luthaf merged 1 commit into
metatensor:mainfrom
Luthaf:create-doc-classes
May 20, 2026
Merged

Allow creating the documentation-only classes#230
Luthaf merged 1 commit into
metatensor:mainfrom
Luthaf:create-doc-classes

Conversation

@Luthaf
Copy link
Copy Markdown
Member

@Luthaf Luthaf commented May 19, 2026

Downstream code might create these at the top level, so erroring in the __init__ means that is it not even possible to import the package for documentation.

xref metatensor/metatrain#1144

@sofiia-chorna can you try building the docs with this PR?

Contributor (creator of pull-request) checklist

  • Tests updated (for new features and bugfixes)?
  • Documentation updated (for new features)?
  • Issue referenced (for PRs that solve an issue)?

Reviewer checklist

  • CHANGELOG updated with public API or any other important changes?

Downstream code might create these at the top level, so erroring in the
`__init__` means that is it not even possible to import the package
for documentation
@sofiia-chorna
Copy link
Copy Markdown
Contributor

yes sure, checking

@sofiia-chorna
Copy link
Copy Markdown
Contributor

sofiia-chorna commented May 19, 2026

seems ok! tox -e docs passed locally:
tox-docs-override.log

i did this in the pyproject.toml:

[tool.uv]
override-dependencies = [
    "metatomic-torch @ git+https://github.com/Luthaf/metatomic.git@create-doc-classes#subdirectory=python/metatomic_torch",
    "metatomic-ase @ git+https://github.com/Luthaf/metatomic.git@create-doc-classes#subdirectory=python/metatomic_ase",
]
``
architecture tests also passing


@Luthaf
Copy link
Copy Markdown
Member Author

Luthaf commented May 19, 2026

Ok, thanks for checking! I'll put this in another release then!

@Luthaf Luthaf merged commit 620c6da into metatensor:main May 20, 2026
10 checks passed
@Luthaf Luthaf deleted the create-doc-classes branch May 20, 2026 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants