Skip to content

Add mkdocs support#11

Merged
gonzalocasas merged 13 commits intomainfrom
mkdocs
Mar 17, 2026
Merged

Add mkdocs support#11
gonzalocasas merged 13 commits intomainfrom
mkdocs

Conversation

@gonzalocasas
Copy link
Copy Markdown
Member

@gonzalocasas gonzalocasas commented Mar 13, 2026

This adds an invoke task for mkdocs. It is not a breaking change, it needs to be explicitly imported from a different module by the user. It depends on this PR on the compas-actions.docs and at the moment, it explicitly points to it, but as soon as that is merged, I will update this PR.

The docs of this very repo are also updated to use mkdocs:
image

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@gonzalocasas gonzalocasas changed the title Add mkdocs Add mkdocs support Mar 13, 2026
@gonzalocasas gonzalocasas requested a review from tomvanmele March 13, 2026 18:49
Copy link
Copy Markdown
Member

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

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

LGTM!

@gonzalocasas gonzalocasas merged commit 3718dad into main Mar 17, 2026
6 of 7 checks passed
@gonzalocasas gonzalocasas deleted the mkdocs branch March 17, 2026 16:24
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