Skip to content

Updates virtualenv docs page #2 #99

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

Merged
merged 6 commits into from
May 1, 2025
Merged

Conversation

kevin-dimichel
Copy link
Contributor

Rationale

In PR #92, @Burhan-Q contributed some improvements. In PRs #87 and #94, we moved files around. This affected #92. To preserve the contributions and not make the community contributor perform the chore of rebasing of main, I checked out the PR (as recommended by @thesteve0) using

git fetch origin pull/92/head:kevin/Burhan-Q-venv-update

rebased off main, and fixed the pre-commit violation.

Below is a copy/past from #92:

Splitting out changes introduced in #30 specifically for docs/getting_started/basic/virtualenv.md page.

Changes

  • Adds annotations to code fenced content
  • Adds tabbed content
  • Fixes spacing between $`$ and $,$
  • Adds code markers to package names in hyperlink text
  • Adds Warning admonition
  • Adds uv bullet and .venv setup steps
  • Adds document front-matter and keywords

Testing

  • Deployed locally with mkdocs to view changes
  • Ran pre-commit for formatting

Note

Errors throw from pre-commit hooks likely due to mkdocs-material formatting

markdownlint.........................................................................Failed
- hook id: markdownlint
- exit code: 1

docs/getting_started/basic/virtualenv.md:105 MD046/code-block-style Code block style 
    [Expected: indented; Actual: fenced]

markdownlint-fix.....................................................................Failed
- hook id: markdownlint-fix
- exit code: 1

Screenshots

Tabbed content screenshot

image

Code block annotation screenshot

Collapsed

image

Expanded

image

Addition of uv and Warning admonition

image

@kevin-dimichel kevin-dimichel requested a review from a team as a code owner May 1, 2025 15:40
@kevin-dimichel kevin-dimichel requested review from a team May 1, 2025 15:40
@kevin-dimichel kevin-dimichel merged commit 0787a76 into main May 1, 2025
1 check passed
@kevin-dimichel kevin-dimichel deleted the kevin/Burhan-Q-venv-update branch May 1, 2025 15:47
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