Skip to content

Commit

Permalink
doc: copy custom CSS on guides build
Browse files Browse the repository at this point in the history
The custom CSS file for Sphinx guides was copied during install,
but not during build time.
Before switching to Meson, the Makefile was copying this file
in the build steps, so the doc was complete and viewable
from the build directory.

It is especially useful to get full documentation in the build directory
when building only documentation with "ninja -C build doc".
The command "ninja install" was required to get the CSS file installed,
but it requires to build the libraries as well.

The CSS file is now copied as part of the Sphinx build script,
and it will be installed as part of the whole html directory.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  • Loading branch information
tmonjalo committed Jul 31, 2024
1 parent 77f96cb commit c946829
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
10 changes: 10 additions & 0 deletions buildtools/call-sphinx-build.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# Copyright(c) 2019 Intel Corporation
#

import filecmp
import shutil
import sys
import os
from os.path import join
Expand Down Expand Up @@ -30,4 +32,12 @@
with open(join(dst, '.html.d'), 'w') as d:
d.write('html: ' + ' '.join(srcfiles) + '\n')

# copy custom CSS file
css = 'custom.css'
src_css = join(src, css)
dst_css = join(dst, 'html', '_static', 'css', css)
if not os.path.exists(dst_css) or not filecmp.cmp(src_css, dst_css):
os.makedirs(os.path.dirname(dst_css), exist_ok=True)
shutil.copyfile(src_css, dst_css)

sys.exit(process.returncode)
2 changes: 0 additions & 2 deletions doc/guides/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,5 @@ html_guides = custom_target('html_guides',
install: get_option('enable_docs'),
install_dir: htmldir)

install_data(files('custom.css'), install_dir: join_paths(htmldir,'_static', 'css'))

doc_targets += html_guides
doc_target_names += 'HTML_Guides'

0 comments on commit c946829

Please sign in to comment.