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

DOC - Enhancements to Sphinx documentation #648

Closed
wants to merge 2 commits into from

Conversation

trallard
Copy link
Contributor

@trallard trallard commented Dec 11, 2024

This PR;

  • Fixes the index.md syntax so that the grid is visible; when this was ported, some linter/formatter might have messed up with the markdown syntax. Is there a way to skip this document or markdown files in /docs, and we can format those via pre-commit? Otherwise, this might continue to cause issues with myst/rst formatting in the long run
  • Hides in-page table of contents
  • I also changed the slug in the PR action to google-grain, but I am unsure if this is correct (need @iindyk to confirm).
  • Remove private_members from autoapi

📚 Documentation preview 📚: https://google-grain--648.org.readthedocs.build/

@trallard trallard changed the title Patch RTD landing page DOC - Enhancements to Sphinx documentation Dec 11, 2024
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
@copybara-service copybara-service bot mentioned this pull request Dec 11, 2024
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705158096
copybara-service bot pushed a commit that referenced this pull request Dec 11, 2024
Ported from #648

PiperOrigin-RevId: 705179128
@iindyk
Copy link
Collaborator

iindyk commented Dec 11, 2024

ported in #649

@iindyk iindyk closed this Dec 11, 2024
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.

2 participants