mbox series

[0/2] publish HTML documentation on readthedocs.org

Message ID 20200421101159.6345-1-xypron.glpk@gmx.de
Headers show
Series publish HTML documentation on readthedocs.org | expand

Message

Heinrich Schuchardt April 21, 2020, 10:11 a.m. UTC
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.

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

--
2.26.1

Comments

Tom Rini April 21, 2020, 2:15 p.m. UTC | #1
On Tue, Apr 21, 2020 at 12:11:57PM +0200, Heinrich Schuchardt wrote:

> 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.
> 
> 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!