Skip to content
Snippets Groups Projects
Commit 422cd22c authored by Jan Včelák's avatar Jan Včelák :rocket:
Browse files

doc: separate Sphinx config for autotools variables

Having these variables in a separate file allows making changes into the
Sphinx configuration file without running './configure'.
parent 498a6a71
No related branches found
No related tags found
No related merge requests found
......@@ -92,7 +92,3 @@
*.gcno
/coverage.info
/coverage.html
# sphinx documentation
/doc/_build/
/doc/conf.py
......@@ -407,7 +407,7 @@ AC_CONFIG_FILES([Makefile
src/dnssec/man/knsec3hash.1
src/dnssec/tests/Makefile
src/dnssec/utils/Makefile
doc/conf.py
doc/conf_autotools.py
man/khost.1
man/knotc.8
man/knotd.8
......
*.info
*.pdf
*.html
*.dvi
*.aux
*.cp
*.fn
*.ky
*.log
*.pg
*.toc
*.tp
*.vr
texinfo.tex
version.texi
mdate-sh
stamp-vti
!/logo.pdf
\ No newline at end of file
/_build
/conf_autotools.py
......@@ -16,10 +16,13 @@ import sys, os, time
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# variables generated on './configure'
from conf_autotools import version, release, today
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
......@@ -49,9 +52,9 @@ author = 'CZ.NIC Labs <http://www.knot-dns.cz>'
# built documents.
#
# The short X.Y version.
version = '@VERSION@'
#version = ''
# The full version, including alpha/beta/rc tags.
release = '@VERSION@'
#release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -59,7 +62,7 @@ release = '@VERSION@'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
today = '@RELEASE_DATE@'
#today = False
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
......@@ -219,7 +222,7 @@ latex_domain_indices = False
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('reference', 'knot.conf', 'Knot DNS configuration file', author, 5)
('reference', 'knot.conf', 'Knot DNS configuration file', author, 5),
]
# If true, show URL addresses after external links.
......
# -*- coding: utf-8 -*-
#
# Sphinx options generated by autotools on './configure'.
#
# The short X.Y version.
version = '@VERSION@'
# The full version, including alpha/beta/rc tags.
release = '@VERSION@'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
today = '@RELEASE_DATE@'
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment