[PLA-13752] Address documentation generation warnings. #910
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
anoto-moniz
changed the base branch from
main
to
feature/pla-13149-bump-dependencies
anoto-moniz
commented
Jan 5, 2024
kroenlein
approved these changes
Jan 9, 2024
Collaborator
kroenlein
left a comment
kroenlein
left a comment
There was a problem hiding this comment.
Thank you for cleaning this up.
anoto-moniz
force-pushed
the
feature/pla-13752-correct-warnings-in-docs-build
branch
from
679a71a to
df14af8
Compare
anoto-moniz
force-pushed
the
feature/pla-13149-bump-dependencies
branch
2 times, most recently
from
6488b93 to
6b94156
Compare
Base automatically changed from
feature/pla-13149-bump-dependencies
to
release/v3.0
January 9, 2024 19:26
Since we're generating our API docs, one of our tables of contents must link to it, or else it will throw a warning. So I've added it to the main page. That main page TOC goes multiple levels deep, so it will show the generated page's name. Since we were starting it at src/, that was its name, which wouldn't make much sense to users. So I tweaked it to start at src/citrine/.
anoto-moniz
force-pushed
the
feature/pla-13752-correct-warnings-in-docs-build
branch
from
df14af8 to
7202b4a
Compare
anoto-moniz
deleted the
feature/pla-13752-correct-warnings-in-docs-build
branch
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.
Citrine Python PR
PR Type:
Adherence to team decisions