Skip to content

[Docs] Clean up docs build #1660

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aireilly
Copy link
Collaborator

@aireilly aireilly commented Jul 18, 2025

SUMMARY:
This PR takes the fine work done in #1436 and cleans up some unused bits and pieces. Maybe we should merge #1436 first for clarity? 🤷

TODO:

  • Set up mike in the CI (?)
  • Is there a docs preview CI for PRs we can leverage?

For mike maybe:

# .github/workflows/deploy-docs.yml
name: Deploy versioned docs

on:
  push:
    branches:
      - main
    tags:
      - 'v*.*.*'

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:

      - uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: cd docs && make install

      - name: Deploy docs
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          if [[ "${{ github.event_name }}" == "push" && "${{ github.ref_type }}" == "tag" ]]; then
            VERSION=${{ github.ref_name }}
            mike deploy "$VERSION" --push --update-aliases latest
          else
            mike deploy latest --push
          fi

@aireilly aireilly marked this pull request as draft July 18, 2025 14:06
Copy link

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

gemini-code-assist[bot]

This comment was marked as outdated.

gemini-code-assist[bot]

This comment was marked as outdated.

@aireilly aireilly changed the title Clean up docs build [Docs] Clean up docs build Jul 18, 2025
@aireilly aireilly force-pushed the mkdocs-tweak branch 2 times, most recently from ed8e625 to 99749e6 Compare July 21, 2025 08:42
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.

1 participant