Resolved warnings during document generation. #408
Conversation
This file contains 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
…to feature/document_warning
yoshipon
requested changes
Jan 5, 2025
.github/workflows/publish_pages.yaml
Outdated
| @@ -18,7 +18,7 @@ jobs: | |||
| python -m pip install .[all_dev] | |||
| - name: Sphinx build | |||
| run: | | |||
| sphinx-apidoc --maxdepth 2 -f -o ./docs/source/api_reference/ ./aiaccel/ | |||
| sphinx-apidoc --maxdepth 2 -f -o ./docs/source/api_reference/ -s inc ./aiaccel/ | |||
There was a problem hiding this comment.
ありがとうございます．こちらですが，workaroundの類なので，あとから意図が分かるよう参照した記事のリンクをコメントで追記下さい．
また，incで名前が良いのか不安です．incが何の略か分かっていないのですが，慣例でしょうか？ あまり例がなければ，例えば，*.rst_ にするなど，実態を分かり易くした方が良いかなと思いました．ご検討お願いします．
There was a problem hiding this comment.
開発者会議メモ
- 拡張子を変更する warning 回避策は削除して、それで表示される警告文に関してはそのままにしておく
…to feature/document_warning
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.
ドキュメント生成時に発生していた各種警告文を解消しました。