Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Update README intro and improve docs build process.

Note that I also looked into enable edit link on the docs via:

edit_uri: edit/main/docs/

theme:
  features:
  - content.action.edit
  - content.action.view

Which works, but also shows up in the API docs pages and those links are broken.

Fixes N/A

Type of Change

  • Breaking Change (fix or enhancement which changes existing semantics of the public interface)
  • Enhancement (new features or improvements to existing functionality)
  • Bug (fixes for a bug or issue)
  • Internal (refactoring, style changes, testing, optimizations)
  • Documentation update (changes to documentation or examples)
  • Package (dependencies, versions, package metadata)
  • Development (CI workflows, pre-commit, linters, templates)
  • Security (security related changes)

Testing

N/A

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Tags added to PR (e.g., breaking, bug, enhancement, internal, documentation, package, development, security).
  • Code changes pass pre-commit (e.g., mypy, ruff, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added the documentation Improvements or additions to documentation or examples label Sep 6, 2024
@gpauloski gpauloski merged commit bfdaee3 into main Sep 6, 2024
@gpauloski gpauloski deleted the docs-build branch September 6, 2024 15:06
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 or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants