docs: create API reference page, link class/namespace/... references in navigation #194
Conversation
This file contains 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
5 tasks
drwnz
approved these changes
Nov 5, 2024
drwnz
reviewed
Nov 5, 2024
drwnz
reviewed
Nov 5, 2024
drwnz
reviewed
Nov 5, 2024
drwnz
reviewed
Nov 5, 2024
Co-authored-by: David Wong <[email protected]>
Signed-off-by: Max SCHMELLER <[email protected]>
|
@drwnz Fixed by adding a |
mojomex
added a commit
that referenced
this pull request
Nov 8, 2024
…in navigation (#194) * docs: add API reference page and add things like class references to nav * Apply suggestions from code review Co-authored-by: David Wong <[email protected]> * docs: fix case style of API reference heading Signed-off-by: Max SCHMELLER <[email protected]> --------- Signed-off-by: Max SCHMELLER <[email protected]> Co-authored-by: David Wong <[email protected]>
mojomex
added a commit
that referenced
this pull request
Nov 11, 2024
…or model (#195) * docs: create API reference page, link class/namespace/... references in navigation (#194) * docs: add API reference page and add things like class references to nav * Apply suggestions from code review Co-authored-by: David Wong <[email protected]> * docs: fix case style of API reference heading Signed-off-by: Max SCHMELLER <[email protected]> --------- Signed-off-by: Max SCHMELLER <[email protected]> Co-authored-by: David Wong <[email protected]> * chore(docs): add `mkdocs_macros.py` for schema table rendering * docs: add vendor pages for parameters * docs: add parameter pages for all sensors * chore(schema): restrict `sensor_model` parameter to only the sensor model in the current schema file * chore(docs): update requirements.txt to match Autoware * docs: add docs build instructions to readme * ci(pre-commit): autofix * chore(docs): make `include_refs` default * ci(pre-commit): autofix * chore(docs): remove empty about page as the index page already contains an about section * docs: deprecate old point types * docs: update support status for sensors * docs: re-arrange nav to reflect user needs better * docs: document common parameters * docs: revert status of currently not fully tested sensors * docs: add figures and more detailed explanation to the scan angle section for Hesai * English lesson Co-authored-by: David Wong <[email protected]> * chore: apply suggested phrasing changes Signed-off-by: Max SCHMELLER <[email protected]> * chore: move Hesai-specific parameters to Hesai schema Signed-off-by: Max SCHMELLER <[email protected]> * docs: add parameter table for Hesai Signed-off-by: Max SCHMELLER <[email protected]> --------- Signed-off-by: Max SCHMELLER <[email protected]> Co-authored-by: David Wong <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Type
Description
This PR should make it much user-friendlier to navigate through the API reference.
Review Procedure
Run
and confirm the API reference tab is working as expected.
Pre-Review Checklist for the PR Author
PR Author should check the checkboxes below when creating the PR.
Checklist for the PR Reviewer
Reviewers should check the checkboxes below before approval.
Post-Review Checklist for the PR Author
PR Author should check the checkboxes below before merging.
CI Checks