Docs/add errors to reference section #1686
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 <manuel.ziegler@pionix.de> Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(explanation): Add community channels to docs Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…inx (#1477) * Refactor _find_sphinx_build macro to allow system installation of sphinx Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> * 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 <kai-uwe.hermann@pionix.de> --------- Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de> Co-authored-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Added Plug&Charge tutorial to docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Configure Plug&Charge in EVerest --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add OCPP1.6 tutorial --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(how-to): Add debug ISO15118 documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add develop new modules --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(linux/yocto): Added several documentation parts for Linux/Yocto integration --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
…ging Regulations to documentation (#1494) Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Renesas MPU docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
… as part of EVerest doc (#1564) * docs(api): Move asyncapi spec and provide HTMLs as part of EVerest doc --------- Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
…nt) (#1581) Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
* doc(how-to): Add BringUp documentation for basic, ac, dc and powermeter bringup --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(explanation): Add adapt EVerest documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(getting-started): Added Getting Started guides for SW and HW --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
unresolved refs with "TODO") Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…ly to APIs Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Pietfried
force-pushed
the
feature/docs-migration
branch
from
f572402 to
cbc4b76
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
Errors were missing from the reference section.
WIP: Still incomplete, since the errors are only listed on the interface pages
Issue ticket number and link
Checklist before requesting a review