docs: add source documentation for readthedocs poe task#821
Draft
qlrd wants to merge 2 commits intoselfcustody:developfrom
Draft
docs: add source documentation for readthedocs poe task#821qlrd wants to merge 2 commits intoselfcustody:developfrom
readthedocs poe task#821qlrd wants to merge 2 commits intoselfcustody:developfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #821 +/- ##
========================================
Coverage 97.31% 97.31%
========================================
Files 83 83
Lines 10576 10576
========================================
Hits 10292 10292
Misses 284 284 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
qlrd
force-pushed
the
docs/readthedocs-rst-source
branch
2 times, most recently
from
c909a36 to
8c7980f
Compare
Krux lack of a techinical documentation. This commit add `sphinx` module to generate a proper [readthedocs](https://readsthedocs.com/) documentation for Krux firmware (and not a user documentation) and a setup for install aditional deps, generation of rst files, build to html files and serve.
This commit add a big set of techinical documentation for every package, module and function of krux `firmware`. It's important to say that the `src.boot` isnt autogenerated and `src.krux` is. This happen because of issues during setup that could be fixed in a followup.
qlrd
force-pushed
the
docs/readthedocs-rst-source
branch
from
8c7980f to
8b60766
Compare
19 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What is this PR for?
Add a big set of techinical documentation for every package, module and function of krux
firmware. It's important to say that thesrc.bootisnt autogenerated andsrc.kruxis. This happen because of issues during setup that could be fixed in a followup.Depends on #819
Changes made to:
Did you build the code and tested on device?
What is the purpose of this pull request?