Repository navigation
Conversation
… and the source MkDocs + Material + mkdocstrings, published to GitHub Pages (ADR 0013). - The user guide is the README itself, included between snippet markers that PyPI and GitHub do not render: one source, no second copy to drift. - The API reference is read statically by griffe, never imported, and lists each public name explicitly, so the Windows-only MetaTrader5 package and the computed __all__ never reach it. - Docstrings on every public name and method, and on each ErrorKind member. tests/unit/test_api_reference.py fails on a public name without a reference entry or docstring. - .github/workflows/docs.yml builds with --strict on every pull request and deploys the same build from master; broken links, anchors, includes and pages left out of the navigation fail it. Chose MkDocs over Sphinx because autodoc imports the package, which needs MetaTrader5 mocked on Linux and follows the computed __all__ into the whole MT5 namespace. Chose one workflow for check and deploy over a job in ci.yml, because two copies of the build would drift apart.
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.
What
A documentation site at https://akinzou.github.io/MetaTrader5-Python/ (MkDocs + Material + mkdocstrings, GitHub Pages), see ADR 0013:
MetaTrader5and the computed__all__never reach it.ErrorKindmember.Guards
tests/unit/test_api_reference.pyfails on a public name without a reference entry or docstring, a public method without a docstring, or anErrorKindmember that does not say what it means. It was red before the docstrings were written..github/workflows/docs.ymlrunsmkdocs build --stricton every PR: a broken link or anchor, a missing README include, or a page left out of the nav fails it. The same workflow deploys from master; the deploy job never runs for PRs or branches.Verification
check_file_length.py,mkdocs build --strict,twine check --strict, and a dry run ofpin_readme_links.pyagainstrefs/tags/v3.0.1(31 links pinned)./code-review high: 10 findings, all fixed. Four docstrings promised more than the code does (retried retcodes,Stop.parsestill raisingTypeErrorfor a bad kind,Stop.pointsraising on zero/NaN,Trader"every call returns a Result"); a landing card and the README "Why" omitted that missing quotes are retried too. The PR docs build is merged into the deploy workflow, so the check and the deploy cannot drift apart.Residual risk
mkdocs.yml) stays cheap.DocumentationURL on PyPI appears with the next release; no release is cut for this.