Skip to content

Lazydocs to mkdocstrings - #194

Merged
Saul (nasaul) merged 24 commits into
mainfrom
lazydocs-to-mkdocstrings
Nov 12, 2025
Merged

Saul (nasaul) merged 24 commits into
mainfrom
lazydocs-to-mkdocstrings

Conversation

@nasaul

@nasaul Saul (nasaul) commented Oct 7, 2025 •

Copy link
Copy Markdown
Contributor
  • Updates workflow for mkdocstrings
  • Create files for documentation
  • build-docs workflow for PRs
  • Test skips docs files
  • Updated docs to include images
  • Ensure same links as nixtlaverse
  • Simplified trigger condition
  • Ignores testing while pushing modifications in:
    • docs/**
    • Makefile
    • **.md
    • nbs/**
    • .gitignore
    • build-docs.yaml

@deven367

Copy link
Copy Markdown
Contributor

One final thing, should we also migrate to docs.json in this PR itself?

Comment thread nbs/_quarto.yml Resolved

@deven367 Deven Mistry (deven367) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just some minor questions about the _quarto.yml file and build-docs.yml

@deven367 Deven Mistry (deven367) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The rendered documentation looks amazing!! It's good to go now!

@nasaul
Saul (nasaul) merged commit 5c5758b into main Nov 12, 2025
21 checks passed
@nasaul
Saul (nasaul) deleted the lazydocs-to-mkdocstrings branch November 12, 2025 18:56
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