Merge pull request #250 from martin-belanger/doc-v3

doc: Clean up. Unable to generate usable RST from HTML.
linux-nvme · Oct 11, 2022 · 004d9b1 · 004d9b1
2 parents 08615fc + dca2214
commit 004d9b1
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/doc/man/meson.build b/doc/man/meson.build
@@ -13,6 +13,10 @@ if want_man or want_html
     docbklst = find_program('genlist-from-docbooks.py')
     dbusgen  = find_program('gdbus-codegen')
 
+    #if readthedocs
+    #    pandoc = find_program('pandoc')
+    #endif
+
     if xsltproc.found()
         manpage_style = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
         if run_command(xsltproc, '--nonet', manpage_style, check: false).returncode() != 0
@@ -101,7 +105,7 @@ if want_man or want_html
 
         if want_html
             html = stem + '.html'
-            custom_target(
+            html_file = custom_target(
                 html,
                 input: file,
                 output: html,
@@ -110,6 +114,25 @@ if want_man or want_html
                 install: want_html,
                 install_dir: join_paths(docdir, 'html')
             )
+
+            # Convert HTML to RST
+            #if readthedocs
+            #    rst = stem + '.rst'
+            #    custom_target(
+            #        rst,
+            #        input: html_file,
+            #        output: rst,
+            #        build_by_default: true,
+            #        command: [
+            #            pandoc,
+            #            '-f', 'html',
+            #            '-t', 'rst',
+            #            '-o', '@OUTPUT@',
+            #            '@INPUT@'
+            #        ]
+            #    )
+            #endif
         endif
     endforeach
 endif
+
diff --git a/meson_options.txt b/meson_options.txt
@@ -2,5 +2,5 @@
 
 option('man',             type: 'boolean', value: false, description: 'build and install man pages')
 option('html',            type: 'boolean', value: false, description: 'build and install html pages')
-option('readthedocs',     type: 'boolean', value: false,  description: 'Only build documentation for Read The Docs')
+option('readthedocs',     type: 'boolean', value: false,  description: 'to be used by Read-The-Docs documentation builder')
 #option('check_pymodules', type: 'boolean', value: true,  description: 'whether to look for missing python module')