-
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
Open
ryan-steel
wants to merge
20
commits into
eclipse-score:main
Choose a base branch
from
etas-contrib:docs/ryan-steel-LudwigAtBosch-user-manual
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
04085a8
docs: add examples user documentation
00f95df
docs: remove API specifics from the examples docs
261d68a
feat(docs): Create public user manual for time module
LudwigWeise c3fd62a
fix(docs): Correct RST structure and apply review feedback
LudwigWeise 094c15e
fix(docs): Integrate user manual into main documentation toctree
LudwigWeise 0f17969
Merge branch 'docs/document-examples' of https://github.com/etas-cont…
1cb0e96
add user manuals
1ca194b
chore: address comments
fe616ec
chore: update docs_as_code version and use score_sphinx_bundle
4455752
use docs_as_code 6.0 bundles
c8de935
chore: format
894e309
remove include_patterns
9da9c42
chore: address comments
ryan-steel d6cb760
docs: update safety tag to fix build
ryan-steel 3bd1d5d
chore: Merge branch 'main' of https://github.com/etas-contrib/score_t…
ryan-steel 3befa2a
chore: address comments
ryan-steel 15b1656
docs: use latest module_template layout, update to docs_as_code v7
ryan-steel 5a38da3
docs: update template IDs for module time
ryan-steel b811ab6
chore: update to docs-as-code 7.0.1
ryan-steel 1345156
chore: format
ryan-steel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| .. _ components:: | ||
|
|
||
| Components | ||
| ~~~~~~~~~~ | ||
|
|
||
| .. toctree will be filled by docs_bundle via bazel | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
This file was deleted.
Oops, something went wrong.
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
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
| 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.> | ||
|
|
||
| .. 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 |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a bit struggling, why dowe have this subfoler here...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was added following the guide for docs_as_code (and to follow the module_template). I think the module template is more up-to-date than the folder structure layout in the platform docs, but they're inconsistent so we need to follow one as a single source of truth.
I think we should use the module_template as the source of truth since it's the one that's being worked on actively. Thoughts?