Skip to content

Shared docs: fix sphinx-build warnings #58

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

Open
wants to merge 4 commits into
base: shared-docs
Choose a base branch
from
Open

Shared docs: fix sphinx-build warnings #58

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
127d5ef
Development: fix underline length
barsnick Jul 10, 2025
3eac4d0
Firmware: make one RAUC reference anonymous
barsnick Jul 10, 2025
720a3b0
CB energy: move link from nymea.energy to chargebyte.energy
barsnick Jul 10, 2025
b3368f5
Development/Firmware: avoid direct links to index.html pages
barsnick Jul 10, 2025
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
2 changes: 1 addition & 1 deletion cb_energy.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ As mentioned in `setup`_, ``Eco mode`` is only available if at least one root me
Supported devices
=================

Here you find a list of `supported devices <https://www.nymea.energy/integrations/>`_.
Here you find a list of `supported devices <https://www.chargebyte.energy/integrations>`_.
CB energy comes with license, maintenance, support and service level agreement. So for the number of integrations you want to use in your final product (e.g. smart EV charger with embedded HEMS), we make sure all integrations are maintained and work as intended.

Since the fundamental IoT middleware of CB energy - nymea - is open source, you can add your own integration to the stack. The developer guide can be found `here <https://nymea.io/documentation/developers/integrations/getting-started-integration>`_.
Expand Down
4 changes: 2 additions & 2 deletions development.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ A native installation of EVerest on your host system is also recommended, as it
that allow you to start and test EVerest locally on your machine. If the software you developed does
not depend on specific hardware components, it is also possible to test your EVerest module natively
on the local machine before it is executed on the target hardware platform.
Please refer to `Simulating EVerest <https://everest.github.io/nightly/tutorials/run_sil/index.html>`_ for more information
Please refer to `Simulating EVerest <https://everest.github.io/nightly/tutorials/run_sil/>`_ for more information
on how to start your EVerest module in the SiL environment.

If you are starting your program from scratch and considering additional libraries to support specific
Expand All @@ -59,7 +59,7 @@ module. For energy management use cases, a websocket JSON-RPC-based approach to
EVerest stack will be available in the near future. For more information, feel free to contact us.

The process of creating your own EVerest modules is described in the EVerest documentation:
`How to: Develop New Modules <https://everest.github.io/nightly/tutorials/new_modules/index.html>`_.
`How to: Develop New Modules <https://everest.github.io/nightly/tutorials/new_modules/>`_.

.. note::
It is also possible to create your module directly in the everest-core project in the modules directory.
Expand Down
2 changes: 1 addition & 1 deletion development_creating_fw_images.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The next step is to integrate a new EVerest module and build a custom image that
.. _adding-a-custom-everest-module:

Integrating a Custom EVerest Module
------------------------------
-----------------------------------

The EVerest documentation explains the `module concept in detail <https://everest.github.io/nightly/general/04_detail_module_concept.html>`_,
their `configuration <https://everest.github.io/nightly/general/05_existing_modules.html>`_,
Expand Down
2 changes: 1 addition & 1 deletion firmware_programming.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Note, that this helper script does not modify any RAUC status information regard
Firmware Update Customization and Signing
=========================================

After making sure that the customized software is working on the board, there might be the requirement to pack this with our pre-flashed firmware to create your own firmware update file which should be signed. This facilitates the production process. The following steps illustrate how to create your own signed firmware update image. For this you would need a native Linux machine or a Linux virtual machine which includes the tool "`RAUC <https://rauc.readthedocs.io/en/latest/index.html>`_". RAUC is the framework we use for performing our firmware update. During the steps, the tool will be used to extract our firmware image, re-pack it including your customized software and sign the new firmware update image. Note that you need your own Public Key Infrastructure (PKI) to sign firmware update images later.
After making sure that the customized software is working on the board, there might be the requirement to pack this with our pre-flashed firmware to create your own firmware update file which should be signed. This facilitates the production process. The following steps illustrate how to create your own signed firmware update image. For this you would need a native Linux machine or a Linux virtual machine which includes the tool "`RAUC <https://rauc.readthedocs.io/en/latest/>`__". RAUC is the framework we use for performing our firmware update. During the steps, the tool will be used to extract our firmware image, re-pack it including your customized software and sign the new firmware update image. Note that you need your own Public Key Infrastructure (PKI) to sign firmware update images later.

**Steps:**

Expand Down