mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-04 07:55:18 +00:00
Code Issues Releases Wiki Activity

[#866] text ARM, remove ungenerated indices

Browse Source
This commit is contained in:
Andrei Pavel
2021-08-03 15:33:51 +03:00
committed by Tomek Mrugalski
parent f8c84eaa3e
commit efa104ea26
4 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/sphinx/Makefile.am
View File

@@ -61,9 +61,9 @@ api_files =
include $(top_srcdir)/src/share/api/api_files.mk include $(top_srcdir)/src/share/api/api_files.mk
if HAVE_PDFLATEX if HAVE_PDFLATEX
all: html mans pdf all: html mans pdf text
else else
all: html mans all: html mans text
endif endif
# build the list of message files # build the list of message files
@@ -164,6 +164,9 @@ html: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
singlehtml: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst singlehtml: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M singlehtml $(srcdir) $(sphinxbuilddir) $(sphinxopts) $(SPHINXBUILD) -M singlehtml $(srcdir) $(sphinxbuilddir) $(sphinxopts)
text: $(main_sources) api-files.txt mes-files.txt $(srcdir)/arm/platforms.rst
$(SPHINXBUILD) -M text $(srcdir) $(sphinxbuilddir) $(sphinxopts)
$(man8s): mans $(man8s): mans
mans: $(man_sources) api-files.txt mes-files.txt mans: $(man_sources) api-files.txt mes-files.txt

9
doc/sphinx/api2doc.py
View File

@@ -88,8 +88,11 @@ API Reference
rst += '.\n\n' rst += '.\n\n'
for func in sorted(apis.values(), key=lambda f: f['name']): for func in sorted(apis.values(), key=lambda f: f['name']):
name = func['name'] # The dot is added to overcome an overlap of ordinal numbers and text
rst += '.. _ref-%s:\n\n' % name # in the table of contents.
name = '. ' + func['name']
real_name = func['name']
rst += '.. _ref-%s:\n\n' % real_name
rst += name + '\n' rst += name + '\n'
rst += '-' * len(name) + '\n\n' rst += '-' * len(name) + '\n\n'
@@ -120,7 +123,7 @@ API Reference
rst += 'Access: %s *(parameter ignored in this Kea version)* \n\n' % access rst += 'Access: %s *(parameter ignored in this Kea version)* \n\n' % access
# description and examples # description and examples
rst += 'Description and examples: see :ref:`%s command <command-%s>`\n\n' % (name, name) rst += 'Description and examples: see :ref:`%s command <command-%s>`\n\n' % (name, real_name)
# command syntax # command syntax
rst += 'Command syntax:\n\n' rst += 'Command syntax:\n\n'

3
doc/sphinx/conf.py
View File

@@ -116,7 +116,6 @@ pygments_style = None
# #
#html_theme = 'alabaster' #html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
#html_logo = '_static/kea-logo-100x70.png'
html_logo = 'static/kea-imageonly-100bw.png' html_logo = 'static/kea-imageonly-100bw.png'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
@@ -176,6 +175,8 @@ latex_documents = [
(master_doc, 'kea-arm.tex', 'Kea Administrator Reference Manual Documentation', author, 'manual'), (master_doc, 'kea-arm.tex', 'Kea Administrator Reference Manual Documentation', author, 'manual'),
] ]
latex_logo = 'static/kea-logo-200.png'
if os.getenv("READTHEDOCS", "False") == "False": if os.getenv("READTHEDOCS", "False") == "False":
latex_documents.append((messages_doc, 'kea-messages.tex', 'Kea Messages Manual', author, 'manual')) latex_documents.append((messages_doc, 'kea-messages.tex', 'Kea Messages Manual', author, 'manual'))

15
doc/sphinx/index.rst
View File

@@ -1,6 +1,10 @@
.. figure:: static/kea-logo-200.png .. only:: not latex
.. image:: static/kea-logo-200.png
:align: right :align: right
.. _introduction:
################################## ##################################
Kea Administrator Reference Manual Kea Administrator Reference Manual
################################## ##################################
@@ -54,12 +58,3 @@ Kea, can be found in ISC's `Knowledgebase <https://kea.readthedocs.io>`_.
umls umls
grammar/grammar grammar/grammar
arm/acknowledgments arm/acknowledgments
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`