Skip to contentSkip to conversation

publish HTML documentation on readthedocs.org

PATCH New Heinrich Schuchardt 2 participants 6 messages Apr 21, 2020 – Apr 28, 2020

lore
Share & tools
lore
#0 lore raw

cover publish HTML documentation on readthedocs.org

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

#1 lore raw

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

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

---
 doc/conf.py | 2 ++
 1 file changed, 2 insertions(+)
doc/conf.py +2 -0
index 0772fb6f0c..b033de9d3a 100644
@@ -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

#2 lore raw

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

Quoted 3 lines · Heinrich Schuchardt

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

Applied to u-boot/master, thanks!

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/20200428/d5dd35e8/attachment.sig>
#3 lore raw

PATCH 2/2 Add .readthedocs.yml

In reply to 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/.

---
 .readthedocs.yml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 .readthedocs.yml
.readthedocs.yml new file +19 -0
new file mode 100644
index 0000000000..f3fb5ed51b
@@ -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

#4 lore raw

PATCH 2/2 Add .readthedocs.yml

Quoted 6 lines · 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/.

Applied to u-boot/master, thanks!

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/20200428/cd140ce1/attachment.sig>
#5 lore raw

cover publish HTML documentation on readthedocs.org

In reply to Heinrich Schuchardt
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>