Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Python API links to the Docs #2413

Merged
merged 3 commits into from
Dec 28, 2023

Conversation

jasondaming
Copy link
Member

No description provided.

Copy link
Collaborator

@sciencewhiz sciencewhiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@virtuald said the python API docs location will change. wpilibsuite/.github#2 (comment)

@jasondaming
Copy link
Member Author

I assume I can update this to use intersphinx once #2417 is merged.

@virtuald will the same style intersphinx link for replacing these urls? These links will persist through any location changes you plan to make right?

@virtuald
Copy link
Member

virtuald commented Dec 7, 2023

This one could also be intersphinx, but I think you'd want to link to a documentation header, not a particular class or module.

Let me try to get my ducks in a row tonight.

@jasondaming
Copy link
Member Author

Do we need to do this a different way or is this sufficient?

source/index.rst Outdated Show resolved Hide resolved
source/index.rst Outdated Show resolved Hide resolved
@sciencewhiz sciencewhiz merged commit e136189 into wpilibsuite:main Dec 28, 2023
10 checks passed
@jasondaming jasondaming deleted the pythonapidocs branch December 28, 2023 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants