Skip to content
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.

Sign up for GitHub

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

Iox #743 Fix website generation and typos #746

Merged
merged 4 commits into from
Apr 26, 2021
Merged

Iox #743 Fix website generation and typos #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc07f12
iox-#743 Ignore unfound files when generating website
mossmaurice-apexai Apr 15, 2021
4e7e947
iox-#743 Fix include issue
mossmaurice-apexai Apr 19, 2021
457a578
iox-#743 Fix typo on start page
mossmaurice-apexai Apr 19, 2021
85c495f
iox-#743 Generate doxybook2 config files to fix doxygen links, update…
mossmaurice-apexai Apr 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ clangd/
*/doc/xml/
site/
doc/website/API-reference/
tools/website/generated/
*.project
__pycache__
2 changes: 1 addition & 1 deletion doc/website/advanced/iceoryx_utils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Safe building blocks
---
{! ./../iceoryx_utils/README.md !}
{! ../iceoryx/iceoryx_utils/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/callbacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Implementing event triggered callbacks using C++
---

{! ./../iceoryx_examples/callbacks/README.md !}
{! ../iceoryx/iceoryx_examples/callbacks/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/callbacks_in_c.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Implementing event triggered callbacks using C
---

{! ./../iceoryx_examples/callbacks_in_c/README.md !}
{! ../iceoryx/iceoryx_examples/callbacks_in_c/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/ice_access_control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Configuring access rights for shared memory segments
---

{! ./../iceoryx_examples/ice_access_control/README.md !}
{! ../iceoryx/iceoryx_examples/ice_access_control/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/icecrystal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Using the introspection client for debugging
---

{! ./../iceoryx_examples/icecrystal/Readme.md !}
{! ../iceoryx/iceoryx_examples/icecrystal/Readme.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/icedelivery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Sending and receiving data using C++
---

{! ./../iceoryx_examples/icedelivery/README.md !}
{! ../iceoryx/iceoryx_examples/icedelivery/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/icedelivery_in_c.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Sending and receiving data using C
---

{! ./../iceoryx_examples/icedelivery_in_c/README.md !}
{! ../iceoryx/iceoryx_examples/icedelivery_in_c/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/iceensemble.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Using multiple publishers for one topic
---

{! ./../iceoryx_examples/iceensemble/README.md !}
{! ../iceoryx/iceoryx_examples/iceensemble/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/icehello.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Sending data to another process
---

{! ./../iceoryx_examples/icehello/README.md !}
{! ../iceoryx/iceoryx_examples/icehello/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/iceoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Configuring pub/sub settings like history cache size or startup behaviour
---

{! ./../iceoryx_examples/iceoptions/README.md !}
{! ../iceoryx/iceoryx_examples/iceoptions/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/iceperf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Measuring the latency of different IPC mechanisms
---

{! ./../iceoryx_examples/iceperf/README.md !}
{! ../iceoryx/iceoryx_examples/iceperf/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: List of examples
---

{! ./../iceoryx_examples/README.md !}
{! ../iceoryx/iceoryx_examples/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/singleprocess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Communicating in a single process between threads
---

{! ./../iceoryx_examples/singleprocess/README.md !}
{! ../iceoryx/iceoryx_examples/singleprocess/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/waitset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Waiting for events like arrival of data using C++
---
{! ./../iceoryx_examples/waitset/README.md !}
{! ../iceoryx/iceoryx_examples/waitset/README.md !}
2 changes: 1 addition & 1 deletion doc/website/getting-started/examples/waitset_in_c.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Waiting for events like arrival of data using C
---

{! ./../iceoryx_examples/waitset_in_c/README.md !}
{! ../iceoryx/iceoryx_examples/waitset_in_c/README.md !}
4 changes: 2 additions & 2 deletions doc/website/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ title: Home
width="50%">
</p>

Eclipse iceoryx™ is an inter-process-communication midddleware that enables virtually limitless data transmissions at constant time.
Eclipse iceoryx™ is an inter-process-communication middleware that enables virtually limitless data transmissions at constant time.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ouh ... only two d's I thought the third d was to there to praise hypnotoad


| <h2>:material-truck-fast: Fast</h2> | <h2>::material-puzzle: Flexible</h2> | <h2>:material-shield-half-full: Dependable</h2> |
| <h2>:material-truck-fast: Fast</h2> | <h2>:material-puzzle: Flexible</h2> | <h2>:material-shield-half-full: Dependable</h2> |
|----|----|-----|
|<ul><li>True zero-copy shared memory communication</li><li>Message transfers with a latency of less than 1 µs</li><li>Made to handle GBytes/sec data transfers</li></ul>|<ul><li>Support of various operating systems, communication patterns and APIs</li><li>Service discovery enables the design of dynamic systems</li><li>Easy to integrate into frameworks like ROS 2 or AUTOSAR Adaptive</li></ul>|<ul><li>Developed according to automotive requirements</li><li>Implementation based on static memory and lock-free algorithms</li><li>Huge C++ library with safe STL implementations</li></ul>|
|[Learn more](getting-started/what-is-iceoryx.md#fast){ .md-button }|[Learn more ](getting-started/what-is-iceoryx.md#flexible){ .md-button }|[Learn more](getting-started/what-is-iceoryx.md#dependable){ .md-button }|
4 changes: 2 additions & 2 deletions iceoryx_utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ attribute overview of the available Queues:

### Error handling

The Error-Handler is a central instance for collecting al errors and react to them. In the file `error-handling.hpp` are all error enums collected. The Error-Handler has different error-levels, for more information see [error-handling.md](../doc/design/error-handling.md)
The Error-Handler is a central instance for collecting al errors and react to them. In the file `error-handling.hpp` are all error enums collected. The Error-Handler has different error-levels, for more information see [error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/design/error-handling.md)

| class | internal | maybe obsolete | description |
|:-----------------------:|:--------:|:--------------:|:------------|
Expand All @@ -113,7 +113,7 @@ The Error-Handler is a central instance for collecting al errors and react to th

### Log

For information about how to use the logger API see [error-handling.md](../doc/design/error-handling.md)
For information about how to use the logger API see [error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/design/error-handling.md)

| class | internal | maybe obsolete | description |
|:-----------------------:|:--------:|:--------------:|:------------|
Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ markdown_extensions:
- toc:
permalink: 🔗
- meta
- markdown_include.include:
base_path: doc
- markdown_include.include
- admonition
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
Expand Down
46 changes: 36 additions & 10 deletions tools/export-docu-to-website.sh → tools/website/export-docu-to-website.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,22 @@
# mkdocs, v1.1.2
# Doxygen, 1.8.17
# doxybook2, v1.3.1
# mike, v0.5.5
# mike, v1.0.0

set -e

WORKSPACE=$(git rev-parse --show-toplevel)
BASENAME=$(basename $WORKSPACE)
WEBREPO="[email protected]:eclipse-iceoryx/iceoryx-web.git"
TYPE=${1:-local} #`local` starts a local webserver to inspect the results, `publish` pushes the generated doc to iceoryx_web
VERSION=$2
BRANCH=$3

if [ "$BASENAME" != "iceoryx" ]; then
echo "Git folder must be named iceoryx!"
exit 1
fi

cd $WORKSPACE

git checkout $BRANCH
Expand All @@ -42,31 +48,51 @@ cmake -Bbuild -Hiceoryx_meta -DBUILD_DOC=ON
cd $WORKSPACE/build
make -j8 doxygen_iceoryx_posh doxygen_iceoryx_utils doxygen_iceoryx_binding_c doxygen_iceoryx_dds doxygen_iceoryx_introspection

# Generate markdown from doxygen
cd $WORKSPACE

PACKAGES="utils posh c-binding DDS-gateway introspection"

# Generate doxybook2 config files, to have correct links in doxygen docu
mkdir -p $WORKSPACE/tools/website/generated/

for PACKAGE in ${PACKAGES} ; do
FILE=$WORKSPACE/tools/website/generated/doxybook2-$PACKAGE.json
rm -f $FILE
echo "{" >> $FILE
if [ "$TYPE" == "local" ]; then
echo "\"baseUrl\": \"/API-reference/$PACKAGE/\"," >> $FILE
else
echo "\"baseUrl\": \"/$VERSION/API-reference/$PACKAGE/\"," >> $FILE
fi
echo "\"indexInFolders\": false," >> $FILE
echo "\"linkSuffix\": \"/\"," >> $FILE
echo "\"mainPageInRoot\": false" >> $FILE
echo "}" >> $FILE
done

# Generate markdown from doxygen
mkdir -p $WORKSPACE/doc/website/API-reference/utils
doxybook2 --input $WORKSPACE/build/doc/iceoryx_utils/xml/ --output $WORKSPACE/doc/website/API-reference/utils
doxybook2 --input $WORKSPACE/build/doc/iceoryx_utils/xml/ --output $WORKSPACE/doc/website/API-reference/utils --config $WORKSPACE/tools/website/generated/doxybook2-utils.json

mkdir -p $WORKSPACE/doc/website/API-reference/posh
doxybook2 --input $WORKSPACE/build/doc/iceoryx_posh/xml/ --output $WORKSPACE/doc/website/API-reference/posh
doxybook2 --input $WORKSPACE/build/doc/iceoryx_posh/xml/ --output $WORKSPACE/doc/website/API-reference/posh --config $WORKSPACE/tools/website/generated/doxybook2-posh.json

mkdir -p $WORKSPACE/doc/website/API-reference/c-binding
doxybook2 --input $WORKSPACE/build/doc/iceoryx_binding_c/xml/ --output $WORKSPACE/doc/website/API-reference/c-binding
doxybook2 --input $WORKSPACE/build/doc/iceoryx_binding_c/xml/ --output $WORKSPACE/doc/website/API-reference/c-binding --config $WORKSPACE/tools/website/generated/doxybook2-c-binding.json

mkdir -p $WORKSPACE/doc/website/API-reference/DDS-gateway
doxybook2 --input $WORKSPACE/build/doc/iceoryx_dds/xml/ --output $WORKSPACE/doc/website/API-reference/DDS-gateway
doxybook2 --input $WORKSPACE/build/doc/iceoryx_dds/xml/ --output $WORKSPACE/doc/website/API-reference/DDS-gateway --config $WORKSPACE/tools/website/generated/doxybook2-DDS-gateway.json

mkdir -p $WORKSPACE/doc/website/API-reference/introspection
doxybook2 --input $WORKSPACE/build/doc/iceoryx_introspection/xml/ --output $WORKSPACE/doc/website/API-reference/introspection
doxybook2 --input $WORKSPACE/build/doc/iceoryx_introspection/xml/ --output $WORKSPACE/doc/website/API-reference/introspection --config $WORKSPACE/tools/website/generated/doxybook2-introspection.json

# Remove index files
PACKAGES="utils posh c-binding DDS-gateway introspection"
FILES="index_classes.md index_examples.md index_files.md index_modules.md index_namespaces.md index_pages.md"

FILES="index_classes.md index_examples.md index_files.md index_modules.md index_namespaces.md index_pages.md index_groups.md"

for PACKAGE in ${PACKAGES} ; do
for FILE in ${FILES} ; do
rm $WORKSPACE/doc/website/API-reference/$PACKAGE/$FILE
rm -f $WORKSPACE/doc/website/API-reference/$PACKAGE/$FILE
done
done

Expand Down