docs: Add API reference docs#71
Merged
duwenxin99 merged 12 commits intomainfrom Apr 30, 2024
Merged
Conversation
Contributor
duwenxin99
commented
Apr 30, 2024
- Set up API reference documents
- Update github workflow to test for documentation correctness with nox
- Add change log, html template, and convert README file from .md to .rst
- Add requirements.txt in docker/docs
|
🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use -- conventional-commit-lint bot |
averikitsch
requested changes
Apr 30, 2024
| python_version = "3.8" | ||
| warn_unused_configs = true | ||
|
|
||
| exclude = [ |
Collaborator
There was a problem hiding this comment.
Move under mypy overrides
Collaborator
There was a problem hiding this comment.
My comment was incorrect. This should stay under tool.mypy
averikitsch
approved these changes
Apr 30, 2024
averikitsch
approved these changes
Apr 30, 2024
averikitsch
reviewed
Apr 30, 2024
Collaborator
averikitsch
left a comment
There was a problem hiding this comment.
readme = "README.md" ==> readme = "README.rst" in pyproject.toml
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
2 participants
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.