Repository navigation
docs: update the docs and publish the site with GitHub Actions - #124
Merged
Merged
Conversation
Align the specification with the python stubs: renamed fields and corrected signatures, the methods of MoneroDaemon and MoneroWallet that were missing, one row per overload, and the types that the signatures name and had no box (MoneroRpcConnection, MoneroRpcPaymentInfo and the results of the daemon calls) in a new section. The inheritance arrows end on the box and no longer on one of its rows. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…agram The python library exposes MoneroUtils and MoneroRpcConnection, and so does the C++ library they are bound to, as the architecture diagram of monero-cpp shows. Draw both in the two layers, with the python bindings between them and a native arrow to monero-project. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
* The home of the site said monero v0.18.5.1, the submodule builds v0.18.5.3 'Fluorine Fermi', as the readme says. * Mention the keys-only wallet among the features, as monero-cpp does. * The example queries transfers into list[MoneroTransferWallet], which does not exist: the type is MoneroTransfer. * A comment of mkdocs.yml linked a page of mkdocs-material that has been moved. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The readme lists python 3.10 to 3.14, and 3.10 is the oldest the packages are built for (the deb of Ubuntu 22.04). 3.8 and 3.9 were declared but never built or tested. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The type of daemon_connection in the docstring of MoneroWalletFull.open_wallet_data had spaces around the bar, and griffe, which reads the stubs to build the API site, could not parse the field and warned about it. The other docstrings write Optional[X]. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
As monero-c does: a workflow builds the API site and publishes it with actions/deploy-pages from main, and pull requests only build it, strictly, so that a docstring or a reference that does not resolve fails there. The 108 generated files of docs/mkdocs/public leave the repository and the folder is ignored. The site was generated from whatever module was installed on the machine that built it, which is how it came to document an older API than the stubs. The workflow gives mkdocstrings the stubs and nothing else: it copies them into a folder named monero, which is what griffe looks for, and passes it as MONERO_STUBS, read by mkdocs.yml, so the module does not have to be built. requirements.in did not list mkdocstrings and griffe, which the site needs. The pages have to be switched to the GitHub Actions source in the settings of the repository for this to take effect. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Published by the workflow, the site is at the root of the pages of the repository and no longer under /mkdocs/public/, where serving the docs folder of the branch put it. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
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.
Align the data model and API specification with the python stubs, add the utilities and the RPC connection to the architecture diagram, and fix the monero version and a wrong type in the docs.
The API site is no longer committed: a workflow builds it from the stubs with
mkdocs build --strictand publishes it from main, as monero-c does, so the Pages source has to be switched to GitHub Actions and the site moves from /mkdocs/public/ to the root. The minimum python is now 3.10, which the readme already stated.