Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
31844bf
This adds a documentation skeleton to everest-core in its docs/ direc…
krealyt Nov 3, 2025
2a0f1c1
(docs) add community channels (#1448)
andistorm Nov 4, 2025
e9fc01b
doc(pnc): Add Explaination of Plug&Charge in EVerest (#1429)
Pietfried Nov 4, 2025
ea15d69
Refactor _find_sphinx_build macro to allow system installation of sph…
andistorm Nov 4, 2025
283239e
doc(tutorial): Add bazel documentation (#1456)
Pietfried Nov 4, 2025
780c631
Add Plug&Charge tutorial documentation (#1439)
Pietfried Nov 5, 2025
e53f5f8
Add Configure Plug&Charge in EVerest documentation (#1428)
Pietfried Nov 5, 2025
b153642
doc(explanation): Add devtool documentation (#1445)
Pietfried Nov 5, 2025
1e96896
Add OCPP1.6 documentation (#1434)
Pietfried Nov 10, 2025
2f5bf04
doc(tutorial): Added OCPP2.x tutorial to docs (#1435)
Pietfried Nov 12, 2025
99c6630
Add ISO15118 debugging documentation (#1495)
Pietfried Nov 17, 2025
4b0072d
doc(explanation): Add hardware architecture documentation (#1449)
andistorm Nov 17, 2025
2276d0a
Add develop new modules to documentation (#1458)
Pietfried Nov 18, 2025
9a94bce
Add documentation for Linux/Yocto/Cross compilation (#1459)
Pietfried Nov 18, 2025
365e4cf
docs(explanation): Adds how-to guides for Eichrecht and UK Smart Char…
Pietfried Nov 25, 2025
d55e839
doc(explanation): Add High-Level EVerest overview to docs (#1453)
Pietfried Nov 25, 2025
da173ca
Add renesas mpu docs (#1457)
Pietfried Nov 25, 2025
a9aecdf
doc(how-to): Add security best practices to documentation (#1573)
Pietfried Nov 27, 2025
d5c8afe
docs(api): Move EVerest API asyncapi spec and build and provide HTMLs…
cburandt Nov 27, 2025
2c89caa
docs: fix various bugs (broken links, broken formating, missing conte…
cburandt Nov 27, 2025
a263914
Add basic BringUp documentation (#1576)
Pietfried Nov 27, 2025
631d745
Add Adapt EVerest documentation (#1577)
Pietfried Nov 27, 2025
e2ecd25
Add Getting Started documentation (#1574)
Pietfried Nov 27, 2025
067fb80
Formatting fixes in getting started docs
Pietfried Nov 27, 2025
9d9e96f
Fix references in asnycapi docs
Pietfried Nov 27, 2025
5300fc3
Move from doc.rst -> docs/index.rst in BUOcppConsumer and IMDSimulator
Pietfried Nov 27, 2025
48a2eac
Fix broken links
cburandt Dec 1, 2025
d7d96b7
Add TSC section in community channels
Pietfried Dec 3, 2025
fd3a5e5
Updated tsc resources
Pietfried Dec 3, 2025
feda2af
Updated repo to dev-hardware-yocto
Pietfried Dec 8, 2025
ce286ad
Update headline
Pietfried Dec 8, 2025
856a885
Update images
Pietfried Dec 8, 2025
5b29709
Fix TODOs and add EVerest APIs to Getting Started section
Pietfried Dec 9, 2025
77259e9
Minor fixes (links + avoid warnings, remove references to BC, mark
cburandt Dec 11, 2025
7d691b4
Add OTA RAUC partitioning + drivers (from BC appendix)
cburandt Dec 11, 2025
44ddc01
added index.rst for all BU modules
Pietfried Dec 12, 2025
66baa7a
Removed adapt everest from toctree and link in getting started direct…
Pietfried Dec 12, 2025
f4af9b7
Add qa to toc
Pietfried Dec 12, 2025
33aadb4
Remove checkboxes
Pietfried Dec 12, 2025
23275d1
Fix markdown link
Pietfried Dec 12, 2025
679f038
Suppress sphinx warnings
cburandt Dec 12, 2025
5c7b69c
Fix visual appearance and some formatting violations
cburandt Dec 12, 2025
8be93ba
Move Huawei driver docs to docs/index.rst
Pietfried Dec 22, 2025
02038d8
Remove add_subdirectory(doc)
Pietfried Dec 22, 2025
eacde18
Move EnergyManager module docs to seperate chapter in explanation/
Pietfried Dec 22, 2025
c65b5ad
Same hierarchy for module references in TOC as in the filesystem
cburandt Dec 23, 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
7 changes: 4 additions & 3 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ endif()

option(CREATE_SYMLINKS "Create symlinks to javascript modules and auxillary files - for development purposes" OFF)
option(CMAKE_RUN_CLANG_TIDY "Run clang-tidy" OFF)
option(EVEREST_BUILD_API_DOCS "Build EVerest API documentation" OFF)
option(ISO15118_2_GENERATE_AND_INSTALL_CERTIFICATES "Automatically generate and install certificates for development purposes" ON)
option(EVEREST_ENABLE_RUN_SCRIPT_GENERATION "Enables the generation of run scripts (convenience scripts for starting available configurations)" ON)
option(EVEREST_BUILD_DOCS "Build EVerest documentation" OFF)
option(${PROJECT_NAME}_BUILD_TESTING "Build unit tests, used if included as dependency" OFF)
option(BUILD_TESTING "Build unit tests, used if standalone project" OFF)
option(EVEREST_ENABLE_COMPILE_WARNINGS "Enable compile warnings set in the EVEREST_COMPILE_OPTIONS flag" OFF)
Expand Down Expand Up @@ -176,6 +176,9 @@ else()
find_package(OpenSSL 3 REQUIRED)
endif()

if(EVEREST_BUILD_DOCS)
add_subdirectory(docs)
endif()

include(ev-project-bootstrap)

Expand All @@ -192,8 +195,6 @@ add_subdirectory(lib)
# FIXME (aw): this should be optional
add_subdirectory(config)

add_subdirectory(doc)

if(EVEREST_BUILD_APPLICATIONS)
add_subdirectory(applications)
endif()
Expand Down
1 change: 1 addition & 0 deletions THIRD_PARTY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

- [CodeCoverage.cmake](https://github.com/bilke/cmake-modules/blob/master/CodeCoverage.cmake) licensed under [The 3-Clause BSD License](https://opensource.org/licenses/BSD-3-Clause)
- [Nanopb - Protocol Buffers for Embedded Systems](https://github.com/nanopb/nanopb) licensed under [The zlib License](https://opensource.org/licenses/Zlib)
- [sphinx-notfound-page](https://github.com/readthedocs/sphinx-notfound-page) licensed under [The MIT License](https://opensource.org/licenses/MIT)
90 changes: 90 additions & 0 deletions cmake/everest-generate.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,21 @@ function(_ev_add_project)
${TYPES_DIR}/*.yaml
)

if(EVEREST_BUILD_DOCS)
find_package(
trailbook-ext-everest
0.1.0
REQUIRED
PATHS "${CMAKE_SOURCE_DIR}/cmake"
)
foreach(TYPES_FILE ${TYPES_FILES})
trailbook_ev_generate_rst_from_types(
TRAILBOOK_NAME "everest"
TYPES_FILE "${TYPES_FILE}"
)
endforeach()
endif()

_ev_add_types(${TYPES_FILES})

if (CALLED_FROM_WITHIN_PROJECT)
Expand All @@ -70,6 +85,36 @@ function(_ev_add_project)
endif ()
endif ()

# check for API
set(API_DIR "${EVEREST_PROJECT_DIR}/docs/source/reference/EVerest_API")
if (EXISTS ${API_DIR})
message(STATUS "Adding API definitions from ${API_DIR}")
file(GLOB API_FILES
${API_DIR}/*.yaml
)

if(EVEREST_BUILD_DOCS)
find_package(
trailbook-ext-everest
0.1.0
REQUIRED
PATHS "${CMAKE_SOURCE_DIR}/cmake"
)
trailbook_ev_generate_api_doc(
TRAILBOOK_NAME "everest"
API_FILES ${API_FILES}
)
endif()

if (CALLED_FROM_WITHIN_PROJECT)
install(
DIRECTORY ${API_DIR}
DESTINATION "${CMAKE_INSTALL_DATADIR}/everest"
FILES_MATCHING PATTERN "*.yaml"
)
endif ()
endif ()

# check for errors
set(ERRORS_DIR "${EVEREST_PROJECT_DIR}/errors")
if (EXISTS ${ERRORS_DIR})
Expand All @@ -91,6 +136,21 @@ function(_ev_add_project)
${INTERFACES_DIR}/*.yaml
)

if(EVEREST_BUILD_DOCS)
find_package(
trailbook-ext-everest
0.1.0
REQUIRED
PATHS "${CMAKE_SOURCE_DIR}/cmake"
)
foreach(INTERFACE_FILE ${INTERFACE_FILES})
trailbook_ev_generate_rst_from_interface(
TRAILBOOK_NAME "everest"
INTERFACE_FILE "${INTERFACE_FILE}"
)
endforeach()
endif()

_ev_add_interfaces(${INTERFACE_FILES})

if (CALLED_FROM_WITHIN_PROJECT)
Expand Down Expand Up @@ -420,6 +480,36 @@ function (ev_add_module)
endforeach()
endif()

if (EVEREST_BUILD_DOCS)
find_package(
trailbook-ext-everest
0.1.0
REQUIRED
PATHS "${CMAKE_SOURCE_DIR}/cmake"
)
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${MODULE_NAME}/docs/")
trailbook_ev_add_module_explanation(
TRAILBOOK_NAME "everest"
MODULE_NAME "${MODULE_NAME}"
EXPLANATION_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${MODULE_NAME}/docs"
)
endif()
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${MODULE_NAME}/doc.rst")
message(
FATAL_ERROR
"Module ${MODULE_NAME} contains a doc.rst file"
" this is not supported anymore, please move to"
" docs/index.rst, then it will be picked up automatically."
" For now this file will be ignored."
)
endif()
trailbook_ev_generate_rst_from_manifest(
TRAILBOOK_NAME "everest"
MANIFEST_FILE "${CMAKE_CURRENT_SOURCE_DIR}/${MODULE_NAME}/manifest.yaml"
)
endif()


# check if python module
string(FIND ${MODULE_NAME} "Py" MODULE_PREFIX_POS)
if (MODULE_PREFIX_POS EQUAL 0)
Expand Down
28 changes: 0 additions & 28 deletions cmake/fetch_async_api.cmake

This file was deleted.

29 changes: 0 additions & 29 deletions cmake/fetch_async_api_html_template.cmake

This file was deleted.

60 changes: 0 additions & 60 deletions cmake/generate-api-docs.cmake

This file was deleted.

18 changes: 18 additions & 0 deletions cmake/trailbook-ext-everest/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Trailbook Extension for Everest

This CMake package is an extension for the Trailbook CMake package
that provides additional functionality specifically for building
documentation for the Everest project.

The following additional features are provided:

* cmake function: `trailbook_ev_add_module_explanation()`
* cmake function: `trailbook_ev_create_snapshot()`
* cmake function: `trailbook_ev_generate_api_doc()`
* cmake function: `trailbook_ev_generate_rst_from_manifest()`
* cmake function: `trailbook_ev_generate_rst_from_interface()`
* cmake function: `trailbook_ev_generate_rst_from_types()`

Check out the inline documentation of the functions for more details
on how to use them. Each function is defined in its own CMake file
located in this package directory.
Loading
Loading