-
Notifications
You must be signed in to change notification settings - Fork 10
Add user manuals for time module #148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
848c63d
853cba3
261d68a
c3fd62a
094c15e
dac6b19
e9b552b
fed85cb
a2771df
4ef0e0e
96d8f66
61e7a7e
f0ae4bc
223f86d
6f90324
4b65bb2
d738c21
6017036
6cca2e7
70c6f70
68e56c4
4835b25
19bcd4b
db0c9bc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,10 +12,12 @@ | |
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Component Classification | ||
| ======================== | ||
| .. _ components:: | ||
|
|
||
| :Component: time_slave | ||
| :ASIL Level: QM | ||
| :Language: C++ | ||
| :Platform: Linux, QNX | ||
| Components | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't see the components subfolder in the folder structure document so, my question is why it is still here and do we really need it?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's in the module template - gives a place for the docs_as_code docs_bundles to be injected. @anmittag can you confirm whether this will be added to folder.rst?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you should keep it, will be adapted in the template |
||
| ~~~~~~~~~~ | ||
|
|
||
| .. toctree will be filled by docs_bundle via bazel | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
This file was deleted.
|
ryan-steel marked this conversation as resolved.
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Module | ||
| ====== | ||
|
|
||
| <Module sphinx documentation template snippets for the module. The directives and their parameters | ||
| should be updated according to the module and it's components.> | ||
|
Comment on lines
+18
to
+19
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think, this needs to be filled by something meaningful ...
Comment on lines
+18
to
+19
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think, this should be replaced by something meaningful. |
||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. mod:: Time | ||
| :id: mod__time | ||
| :includes: comp__component_name_template | ||
|
|
||
| Module View | ||
| ----------- | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. mod_view_sta:: Time Module Static View | ||
| :id: mod_view_sta__time__time | ||
| :includes: comp__component_name_template | ||
|
|
||
| .. needarch:: | ||
| :scale: 50 | ||
| :align: center | ||
|
|
||
| {{ draw_module(need(), needs) }} | ||
|
|
||
| Module Documents | ||
| ---------------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| manuals/index | ||
Uh oh!
There was an error while loading. Please reload this page.