Skip to content

improve source locations for auxiliary packages in docs#6749

Merged
davidhewitt merged 1 commit intomainfrom
dh/docs-source-paths
Jul 19, 2023
Merged

improve source locations for auxiliary packages in docs#6749
davidhewitt merged 1 commit intomainfrom
dh/docs-source-paths

Conversation

@davidhewitt
Copy link
Copy Markdown
Collaborator

@davidhewitt davidhewitt commented Jul 19, 2023 •
edited by pydantic-hooky Bot
Loading

Change Summary

Currently the source paths for auxiliary packages such as pydantic_core include a .venv prefix. This is an experiment to see if it removes that prefix.

Related issue number

N/A

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @adriangb

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Jul 19, 2023 •
edited
Loading

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3570ffb
Status: ✅  Deploy successful!
Preview URL: https://7fb948b9.pydantic-docs2.pages.dev
Branch Preview URL: https://dh-docs-source-paths.pydantic-docs2.pages.dev

View logs

@davidhewitt davidhewitt force-pushed the dh/docs-source-paths branch from e28a9a1 to 38a094b Compare July 19, 2023 12:37
@davidhewitt davidhewitt force-pushed the dh/docs-source-paths branch from 38a094b to 3570ffb Compare July 19, 2023 13:11
@davidhewitt
Copy link
Copy Markdown
Collaborator Author

davidhewitt commented Jul 19, 2023

Looks like this works well.

See e.g. https://5b69d461.pydantic-docs2.pages.dev/api/pydantic_core_schema/#pydantic_core.core_schema.any_schema

image

Compare this to the current live docs:

image

@davidhewitt davidhewitt marked this pull request as ready for review July 19, 2023 13:32
@davidhewitt
Copy link
Copy Markdown
Collaborator Author

davidhewitt commented Jul 19, 2023

please review

@davidhewitt davidhewitt merged commit c588b5d into main Jul 19, 2023
@davidhewitt davidhewitt deleted the dh/docs-source-paths branch July 19, 2023 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adriangb adriangb adriangb approved these changes

Assignees

@adriangb adriangb

Labels

ready for review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@davidhewitt @adriangb