Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #819 +/- ##
========================================
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
branch
27 times, most recently
from
258631d to
f013256
Compare
Member
|
Thanks for working on this! Just a small clarification: ReadTheDocs is a great tool for API documentation, where there are stable endpoints, request/response schemas, etc. However, Krux is not an API or python / micropython library (lib) - it’s just a firmware for an air-gapped Bitcoin signing device. Because of that distinction, I’d suggest to focus the documentation on technical firmware internals, build instructions, and usage details rather than framing it like an API / lib reference. |
qlrd
force-pushed
the
docs/readthedocs
branch
from
f013256 to
948f32d
Compare
qlrd
force-pushed
the
docs/readthedocs
branch
9 times, most recently
from
e51c0f5 to
8c09916
Compare
9 tasks
qlrd
force-pushed
the
docs/readthedocs
branch
from
8c09916 to
a5b86ed
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.
qlrd
force-pushed
the
docs/readthedocs
branch
from
a5b86ed to
29ed270
Compare
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
2 participants
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?
Krux lack of a techinical documentation. This commit add
sphinxmoduleto generate a proper readthedocs
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.
Changes made to:
Did you build the code and tested on device?
What is the purpose of this pull request?