Skip to content

Migrate to Mkdocs#27

Merged
gonzalocasas merged 10 commits intomainfrom
mkdocs
Apr 16, 2026
Merged

Migrate to Mkdocs#27
gonzalocasas merged 10 commits intomainfrom
mkdocs

Conversation

@gonzalocasas
Copy link
Copy Markdown
Member

@gonzalocasas gonzalocasas commented Mar 24, 2026

image

Migrate to mkdocs, add typing hints everywhere, removed some older stuff

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
Copy link
Copy Markdown
Member Author

@chenkasirer ping ;)

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 but there's still a couple small things missing, I think: the docs workflow needs to be updated to trigger the mkdocs one and if we want to keep references to the old sphinx sites, we need to run the migration script: https://gist.github.com/chenkasirer/d25103d163e7c2868c39ce6f3df8f79c

Comment thread requirements-dev.txt Outdated
Comment on lines +13 to +28
pythonnet
markdown-callouts >=0.4
markdown-exec >=1.8
mike
mkdocs >=1.6
mkdocs-autorefs >=1.4
mkdocs-coverage >=1.0
mkdocs-git-revision-date-localized-plugin >=1.2
mkdocs-llmstxt >=0.2
mkdocs-material >=9.5
mkdocs-minify-plugin >=0.8
mkdocs-redirects >=1.2
mkdocs-section-index >=0.3
mkdocs-mermaid2-plugin
mkdocstrings[python]
pydantic >=2.10
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

aren't a lot of these now conditional dependencies of compas_invocations2?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done!

Base automatically changed from zenoh to main April 16, 2026 09:18
@gonzalocasas gonzalocasas merged commit 9a85e90 into main Apr 16, 2026
13 checks passed
@gonzalocasas gonzalocasas deleted the mkdocs branch April 16, 2026 09:44
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