refactor: move docs from cpp/docs/ to docs/ at repo root#2845
Open
bansiesta wants to merge 8 commits into
Open
refactor: move docs from cpp/docs/ to docs/ at repo root#2845bansiesta wants to merge 8 commits into
bansiesta wants to merge 8 commits into
Conversation
bansiesta
force-pushed
the
move-docs-to-root
branch
from
1c6cc98 to
b0d650e
Compare
julianoes
previously approved these changes
Apr 7, 2026
bansiesta
force-pushed
the
move-docs-to-root
branch
from
9a6ec0c to
1b58015
Compare
Collaborator
|
Ping me when you really want a review, with some expectations - i.e. you just want a sanity check of the concept or whatever. |
Collaborator
|
Thanks @hamishwillee. What's missing is the overall docs explaining what this is, how we move forward with the new Python wrappers, etc. |
julianoes
reviewed
Apr 29, 2026
| - [MAVSDK-CSharp](https://github.com/mavlink/MAVSDK-CSharp) (2019): Proof of concept. | ||
| - [MAVSDK-Rust](https://github.com/mavlink/MAVSDK-Rust) (2019): Proof of concept. | ||
|
|
||
| ## New Python Wrappers (`mavsdk` and `aiomavsdk`) |
The docs cover more than just C++ (Python, Swift, etc.), so move the VitePress site to the repo root level. Update CI workflows (docs_deploy.yml, linux.yml, macos.yml, windows.yml, fuzzing.yml), .gitignore, README, and VitePress edit-on-GitHub links accordingly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add py/tools/generate_markdown.py: AST-based markdown generator
(no import of packages required)
- Add py/tools/generate_docs.sh: called by root tools/generate_docs.sh
- Generate API reference for all 36 plugins into
docs/en/python/api_reference/{mavsdk,aiomavsdk}/
- Update docs/en/python/index.md and SUMMARY.md
- Add root tools/generate_docs.sh orchestrator
- Clean RST inline markup (:class:, :meth:) and fix mixed indentation
in generated docstrings
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
SCRIPT_DIR is cpp/tools/ — one level up landed at cpp/ not the repo root. Go up two levels to reach docs/en/cpp/api_reference/. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Filter out CStruct classes, from_c_struct/to_c_struct methods, and destroy() from generated docs. Replace ctypes.c_void_p with Handle in method signatures.
Replaces the minimal stub with a comprehensive overview page covering what the new Python packages are, how they differ from MAVSDK-Python (direct C library binding vs gRPC+server), when to use mavsdk vs aiomavsdk, installation, and a developer note on the AST-based doc generator. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a dedicated "About This Documentation" section to docs/en/index.md explaining why the docs were moved from cpp/docs/ to the repository root (single PR can update code and docs together), and a "New Python Wrappers" section covering: - What mavsdk and aiomavsdk are (direct libcmavsdk bindings, no gRPC) - How they differ architecturally from MAVSDK-Python - The migration path and long-term direction (intended to replace MAVSDK-Python) - A navigation table so readers can find the right section quickly - Contributor guidance for where to place new documentation Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bansiesta
force-pushed
the
move-docs-to-root
branch
from
30e0424 to
6fb81e8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cpp/docs/todocs/at the repo root, since docs now cover more than just C++ (Python, Swift, etc.)docs_deploy.ymlCI workflow paths, working-directory, and artifact pathlinux.yml,macos.yml,windows.yml,fuzzing.yml.gitignoreentries fornode_modules, cache, and distREADME.mdreferencesNote:
cpp/tools/generate_docs.shalready referenced../docs/so no change needed there.Test plan
🤖 Generated with Claude Code