configure with EVEREST_ENABLE_RS_SUPPORT=ON #1717
Draft
Conversation
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
…tory. (#1380) It is the foundation for the integration of more documentation bits from https://github.com/EVerest/EVerest into this structure. Changes include: * Docs build process and Sphinx configuration * Diataxis skeleton dividing every part of the documentation into: Explaination, How-to-guide, Tutorial, Reference * Added instructions how to build the documentation to everest-core README * Generation of reference documentation Signed-off-by: Krealyt <[email protected]> Signed-off-by: Andreas Heinrich <[email protected]> Signed-off-by: Piet Gömpel <[email protected]> Co-authored-by: Piet Gömpel <[email protected]>
* doc(explanation): Add community channels to docs Signed-off-by: Piet Gömpel <[email protected]> --------- Signed-off-by: Piet Gömpel <[email protected]> Co-authored-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
…inx (#1477) * Refactor _find_sphinx_build macro to allow system installation of sphinx Signed-off-by: Andreas Heinrich <[email protected]> * Fix setting of _SPHINX_BUILD_EXECUTABLE It needs to be a list, otherwise cmake will escape all whitespace which would then lead to a failure executing the command Signed-off-by: Kai-Uwe Hermann <[email protected]> --------- Signed-off-by: Andreas Heinrich <[email protected]> Signed-off-by: Kai-Uwe Hermann <[email protected]> Co-authored-by: Kai-Uwe Hermann <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
* doc(tutorial): Added Plug&Charge tutorial to docs --------- Signed-off-by: Piet Gömpel <[email protected]>
* doc(how-to): Add Configure Plug&Charge in EVerest --------- Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
* doc(tutorial): Add OCPP1.6 tutorial --------- Signed-off-by: Piet Gömpel <[email protected]> Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]> Signed-off-by: Piet Gömpel <[email protected]>
* doc(how-to): Add debug ISO15118 documentation --------- Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]> Co-authored-by: Piet Gömpel <[email protected]>
* doc(tutorial): Add develop new modules --------- Signed-off-by: Piet Gömpel <[email protected]>
* doc(linux/yocto): Added several documentation parts for Linux/Yocto integration --------- Signed-off-by: Piet Gömpel <[email protected]> Signed-off-by: Piet Gömpel <[email protected]>
…ging Regulations to documentation (#1494) Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
* doc(how-to): Add Renesas MPU docs --------- Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
… as part of EVerest doc (#1564) * docs(api): Move asyncapi spec and provide HTMLs as part of EVerest doc --------- Signed-off-by: Christoph Burandt <[email protected]>
…nt) (#1581) Signed-off-by: Christoph Burandt <[email protected]>
* doc(how-to): Add BringUp documentation for basic, ac, dc and powermeter bringup --------- Signed-off-by: Piet Gömpel <[email protected]>
* doc(explanation): Add adapt EVerest documentation --------- Signed-off-by: Piet Gömpel <[email protected]>
* doc(getting-started): Added Getting Started guides for SW and HW --------- Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
This reverts commit cbc4b76.
Signed-off-by: Piet Gömpel <[email protected]>
* doc(module-concept): Add detailed module concept --------- Signed-off-by: Krealyt <[email protected]> Signed-off-by: Manuel Ziegler <[email protected]> Signed-off-by: Andreas Heinrich <[email protected]> Signed-off-by: Piet Gömpel <[email protected]> Signed-off-by: Christoph Burandt <[email protected]> Signed-off-by: cburandt <[email protected]> Signed-off-by: Kai-Uwe Hermann <[email protected]> Co-authored-by: Manuel Ziegler <[email protected]> Co-authored-by: cburandt <[email protected]> Co-authored-by: Kai-Uwe Hermann <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
…he side-bar Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
…ents Signed-off-by: Christoph Burandt <[email protected]>
Restructure module documentation hierarchy to match filesystem: - Generate module reference RST files in hierarchical directory structure matching modules/ filesystem layout instead of flat structure - Auto-generate index.rst files for each directory level with glob patterns - Integrate handwritten module docs (docs/index.rst) into reference section instead of separate explanation section - Rename handwritten docs from index.rst to index.inc when copying - Add errors to interface reference documentation - Support SKIP_DOC_GENERATION option for ev_add_project and ev_add_module - Remove orphaned handwritten doc placeholder files - Update cross-references throughout docs to use new paths --------- Signed-off-by: Christoph Burandt <[email protected]> Signed-off-by: cburandt <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Add build and deploy CI for new documentation: * Restructure Github Workflows * Add scripts to build and deploy docs * Minor fixes for create snapshot feature in docs * Minor adaptions on cmake function add_trailbook * Minor fixes for sphinx extension staticpage --------- Signed-off-by: Andreas Heinrich <[email protected]> Signed-off-by: Piet Gömpel <[email protected]> Co-authored-by: Piet Gömpel <[email protected]>
- Configure conf.py from conf.py.in template with PROJECT_VERSION - Add conf.py to .gitignore as it's now CMake-generated - Fix AsyncAPI documentation links (remove 'reference/' prefix) - Remove orphaned placeholder doc files for slac_API and BUSlac modules Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Christoph Burandt <[email protected]>
Signed-off-by: Andreas Heinrich <[email protected]>
Pietfried
force-pushed
the
feature/docs-migration
branch
from
88a48cd to
ed7bb50
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe your changes
Issue ticket number and link
Checklist before requesting a review