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

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

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

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

[PATCH 1/2] doc: specify that xelatex is used as Latex engine

[Heinrich Schuchardt]

Building the pdf documentation on readthedocs.org fails with pdflatex.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/conf.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/conf.py b/doc/conf.py
index 0772fb6f0c..b033de9d3a 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -31,6 +31,8 @@ from load_config import loadConfig
 # If your documentation needs a minimal Sphinx version, state it here.
 needs_sphinx = '1.3'

+latex_engine = 'xelatex'
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
--
2.26.1

[PATCH 2/2] Add .readthedocs.yml

[Heinrich Schuchardt]

readthedocs.org allows to automatically generate and publish the HTML
documentation for the U-Boot project.

Add a file controlling building https://u-boot.readthedocs.io/.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 .readthedocs.yml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 .readthedocs.yml

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000000..f3fb5ed51b
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,19 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: []
+
+# Optionally set the version of Python and requirements required to build your docs
+# python:
+#   version: 3.7
+#   install:
+#     - requirements: docs/requirements.txt
--
2.26.1

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

[Tom Rini]

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!

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

[PATCH 1/2] doc: specify that xelatex is used as Latex engine

[Tom Rini]

On Tue, Apr 21, 2020 at 12:11:58PM +0200, Heinrich Schuchardt wrote:

> Building the pdf documentation on readthedocs.org fails with pdflatex.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Applied to u-boot/master, thanks!

-- 
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/20200428/d5dd35e8/attachment.sig>

[PATCH 2/2] Add .readthedocs.yml

[Tom Rini]

On Tue, Apr 21, 2020 at 12:11:59PM +0200, Heinrich Schuchardt wrote:

> readthedocs.org allows to automatically generate and publish the HTML
> documentation for the U-Boot project.
> 
> Add a file controlling building https://u-boot.readthedocs.io/.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Applied to u-boot/master, thanks!

-- 
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/20200428/cd140ce1/attachment.sig>