Skip to content

Conversation

@LeonidElkin
Copy link
Collaborator

@LeonidElkin LeonidElkin commented Jan 3, 2026

  • Initialization of documentation via sphinx
  • API documentation is automatically generated from source code
  • Example is automatically generated from examples/*.ipynb
  • Updated example
  • Fixed some issues with code that popped up while updating example
  • Added docs_preview.yml to build and preview what would docs look like in GitHub Pages after merging to main branch
  • Added docs_deploy.yml to build and deploy docs after merging to main branch
  • README updated

Not exactly what applies to PR, but it has been added artifact.ci GitHub App to preview the documentation without uploading to GitHub Pages not from main and without downloading artifacts

@LeonidElkin LeonidElkin requested a review from Desiment January 3, 2026 19:57
@LeonidElkin LeonidElkin self-assigned this Jan 5, 2026
@LeonidElkin LeonidElkin added Documentation Improvements or additions to documentation Example Editing or creating examples labels Jan 5, 2026
@LeonidElkin LeonidElkin merged commit 729d627 into main Jan 5, 2026
14 checks passed
@LeonidElkin LeonidElkin deleted the docs/sphinx-init branch January 5, 2026 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Example Editing or creating examples

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants