doc: improve HTML spacing in release notes
authorThomas Monjalon <thomas@monjalon.net>
Mon, 12 Feb 2018 17:13:44 +0000 (18:13 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Tue, 13 Feb 2018 23:23:25 +0000 (00:23 +0100)
Vertical spacing is lower before an item title than after.
So the items with paragraphs are not well separated.

A custom CSS is added to override the rtd theme.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/guides/conf.py
doc/guides/custom.css [new file with mode: 0644]
mk/rte.sdkdoc.mk

index 77d93ac..cf06f25 100644 (file)
@@ -391,3 +391,5 @@ def setup(app):
         app.add_role('numref', numref_role)
         # Process the numref references once the doctree has been created.
         app.connect('doctree-resolved', process_numref)
+
+    app.add_stylesheet('css/custom.css')
diff --git a/doc/guides/custom.css b/doc/guides/custom.css
new file mode 100644 (file)
index 0000000..c87c606
--- /dev/null
@@ -0,0 +1,7 @@
+/* Override readthedocs theme */
+
+/* Spacing before a list item must be bigger than spacing inside the item.
+ * Complex list items start with a p.first element. */
+.section li > .first {
+       margin-top: 18px;
+}
index de31b78..bce57c5 100644 (file)
@@ -117,7 +117,13 @@ guides-pdf-%:
        $(Q)mv $(RTE_OUTPUT)/doc/pdf/guides/$*/doc.pdf \
                $(RTE_OUTPUT)/doc/pdf/guides/$*.pdf
 
-guides-%:
+guides-html-prepare:
+       $(Q)install -D -m0644 $(RTE_SDK)/doc/guides/custom.css \
+               $(RTE_OUTPUT)/doc/html/guides/_static/css/custom.css
+
+guides-%-prepare: ;
+
+guides-%: guides-%-prepare
        @echo 'sphinx processing $@...'
        $(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
                -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \