Implement setup for building API documentation with mkdocs and GitHub pages #1
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR establishes the initial setup for building API documentation with MkDocs and GitHub Pages while also improving docstrings and import consistency throughout the codebase.
- Clarified and standardized docstrings and comments across protocol, mixin, and builder modules.
- Refactored import paths for query where clauses and updated all exports.
- Added MkDocs configuration, documentation content, and a GitHub Actions workflow to deploy docs.
Reviewed Changes
Copilot reviewed 35 out of 36 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/fluree_py/ledger/protocol/endpoint/create.py | Updated protocol docstrings for clarity in create operations. |
| src/fluree_py/ledger/protocol/endpoint/init.py | Adjusted imports and all exports to remove unused items. |
| src/fluree_py/ledger/mixin/*.py | Added and refined docstrings in mixins for where, context, insert, request, and commit operations. |
| src/fluree_py/ledger/builder/*.py | Added docstrings to builder implementations to document operation endpoints. |
| src/fluree_py/client.py | Added basic docstrings for client methods. |
| pyproject.toml | Added documentation dependencies for MkDocs setup. |
| mkdocs.yml, docs/index.md | New documentation configuration and content files for MkDocs. |
| .github/workflows/docs.yml | GitHub Actions workflow added to deploy the generated docs. |
Files not reviewed (1)
- docs/css/extra.css: Language not supported
Omegaice
added a commit
that referenced
this pull request
Apr 1, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
Omegaice
added a commit
that referenced
this pull request
Apr 3, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
Omegaice
added a commit
that referenced
this pull request
Apr 3, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
Omegaice
added a commit
that referenced
this pull request
Apr 4, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
Omegaice
added a commit
that referenced
this pull request
Apr 4, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
Omegaice
added a commit
that referenced
this pull request
Apr 4, 2025
Omegaice
added a commit
that referenced
this pull request
Apr 16, 2025
… pages (#1) * docs: initial MkDocs setup and GitHub action to build and deploy them
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.
No description provided.