proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-04 13:31:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: make conf.py know about variable substitutions

Browse Source 
The old Texi docs had some Makefile-style variable substitutions they
used to pull in information like release date, configured install path,
etc. Sphinx has this ability as well, we start making use of it here.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2018-01-12 16:00:24 -05:00
parent 8d2098618c
commit 964b36623b
No known key found for this signature in database
GPG Key ID: DAF48E0F57E0834F
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/user/conf.py
View File

@ -24,7 +24,10 @@ import re
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
needs_sphinx = '1.0'
# prolog for various variable substitutions
rst_prolog = ''
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@ -36,7 +39,7 @@ templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
# source_suffix = ['.rst']
source_suffix = '.rst'
# The encoding of source files.
@ -59,6 +62,10 @@ version = u'?.?'
# The full version, including alpha/beta/rc tags.
release = u'?.?-?'
install_prefix_etc = "<install_prefix>"
# extract version information, installation location, other stuff we need to
# use when building final documents
val = re.compile('^S\["([^"]+)"\]="(.*)"$')
with open('../../config.status', 'r') as cfgstatus:
for ln in cfgstatus.readlines():
@ -67,6 +74,17 @@ with open('../../config.status', 'r') as cfgstatus:
if m.group(1) == 'PACKAGE_VERSION':
release = m.group(2)
version = release.split('-')[0]
if m.group(1) == 'CFG_SYSCONF':
install_prefix_etc = m.group(2)
# add substitutions to prolog
rst_prolog += '''
.. |INSTALL_PREFIX_ETC| replace:: {}
.. |PACKAGE_VERSION| replace:: {}
'''.format(install_prefix_etc, version)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.