Starting point for sphinx-based user documentation #74
Conversation
ejoerns
force-pushed
the
topic/sphinx-doc
branch
4 times, most recently
from
aac8c5f
to
b43eb7a
Compare
|
I've rebased this on master so the CI fix is now not part of this anymore. Additionally, I structured it in a way that it starts from a vanilla sphinx-quickstart-generated configuration. The theme is now changed to use readthedocs which requires an additional package but will have the same appearance in local builds as it would have for readthedocs builds. |
ejoerns
force-pushed
the
topic/sphinx-doc
branch
from
b43eb7a
to
59e3e27
Compare
|
@Bastian-Krause I should have finally addressed your review comments now. |
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
As git does not care for empty directories, these directories created by sphinx-quickstart will not exist when cloning the repo. Thus we simply comment them out as long as we do not have any content for them. Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
Make sphinx warnings fatal for CI Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
The structure is derived from the parent 'rauc' project. This also adds a `Developer's Certificate of Origin` Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
ejoerns
force-pushed
the
topic/sphinx-doc
branch
from
59e3e27
to
aa5eb1a
Compare
|
Rebased to benefit from testing fix #76. |
|
@ejoerns Pushed some small fixups, could you have a look and squash them if they look good? |
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
This adds the recently introduced "post_update_reboot" option with an explanation what it does and what it doesn't. Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Enrico Joerns <ejo@pengutronix.de>
ejoerns
force-pushed
the
topic/sphinx-doc
branch
from
390b2c5
to
422d90d
Compare
|
@Bastian-Krause Thanks, they look quite reasonable! I've fixed up all but the one that adds new text and already got a SoB anyway. I left this as a stand-alone commit. |
|
With this merged, we now have https://rauc-hawkbit-updater.readthedocs.io/ |
This adds a basic skeleton for rauc-hawkbit-updater user documentation based on sphinx.
The tests are extended to test for doc (sphinx + doxygen) building, too.
Note that this also contains a fix for the current CI that fails to find changed debian repos.
The next step would then be to register a readthedocs subdomain for this, to allow browsing the documentation online.