Skip to content

publish HTML documentation on readthedocs.org

Tom Rini u-boot 1 version New

Get series with b4
b4 am 20200421141551.GK4555@bill-the-cat

Versions newest first

  1. v1 Latest2 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2doc: specify that xelatex is used as Latex engine+0 -00 replies
2/2Add .readthedocs.yml+0 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/2] publish HTML documentation on readthedocs.org
Quoted 18 lines · Heinrich Schuchardt

readthedocs.org offers a free service to publish generated HTML documentation.

For testing I have set this up for U-Boot using my
https://github.com/xypron2/u-boot repository.

The generated output is available at
https://u-boot.readthedocs.io/en/latest/

In a final version we should implement the necessary git hook on Gitlab and change the source repository to https://gitlab.denx.de/u-boot/u-boot.

Than whenever we update the master branch or create a new tag the documentation will be generated and published.

For a correct functioning of the readathedocs.org build process we need the two appended patches.

Quoted 8 lines

Heinrich Schuchardt (2):
doc: specify that xelatex is used as Latex engine Add .readthedocs.yml

 .readthedocs.yml | 19 +++++++++++++++++++
 doc/conf.py      |  2 ++
 2 files changed, 21 insertions(+)
 create mode 100644 .readthedocs.yml

Very neat, thanks for doing this!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200421/d5e63125/attachment.sig>