mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[#1055] Sphinx now copies platforms.rst

Browse Source
This commit is contained in:
Tomek Mrugalski
2020-03-20 13:56:41 +01:00
committed by Tomek Mrugalski
parent f3ebac017f
commit 05bce34c5d
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/sphinx/conf.py
View File

@@ -211,6 +211,17 @@ def run_generate_docs(_):
mes_files = [os.path.abspath(os.path.join(src_dir, '../..', mf)) for mf in mes_files]
mes2doc.generate(mes_files, os.path.join(src_dir, 'kea-messages.rst'))
# Sphinx has some limitations. It can't import files from outside its directory, which
# in our case is src/sphinx. On the other hand, we need to have platforms.rst file
# in top level directory, so it's easily accessible by prospective and first time
# users. Furthermore, ReadTheDocs does not use makefile system at all and they rely
# on sphinx-build only. As a result we need to conduct some Makefile-like operations
# here. This requires us to copy (or link) the file from the top level to sphinx subdir.
from shutil import copyfile
src = os.path.join(src_dir, '../../platforms.rst')
dst = os.path.join(src_dir, 'arm/platforms.rst')
print("Copying %s to %s" % (src, dst))
copyfile(src, dst)
# custom setup hook
def setup(app):