diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am index fb73ae7028..96cba12ded 100644 --- a/doc/sphinx/Makefile.am +++ b/doc/sphinx/Makefile.am @@ -61,9 +61,9 @@ api_files = include $(top_srcdir)/src/share/api/api_files.mk if HAVE_PDFLATEX -all: html mans pdf +all: html mans pdf text else -all: html mans +all: html mans text endif # 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 $(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 mans: $(man_sources) api-files.txt mes-files.txt diff --git a/doc/sphinx/api2doc.py b/doc/sphinx/api2doc.py index e253d334a9..f4ba57e6b9 100755 --- a/doc/sphinx/api2doc.py +++ b/doc/sphinx/api2doc.py @@ -88,8 +88,11 @@ API Reference rst += '.\n\n' for func in sorted(apis.values(), key=lambda f: f['name']): - name = func['name'] - rst += '.. _ref-%s:\n\n' % name + # The dot is added to overcome an overlap of ordinal numbers and text + # in the table of contents. + name = '. ' + func['name'] + real_name = func['name'] + rst += '.. _ref-%s:\n\n' % real_name rst += name + '\n' rst += '-' * len(name) + '\n\n' @@ -120,7 +123,7 @@ API Reference rst += 'Access: %s *(parameter ignored in this Kea version)* \n\n' % access # description and examples - rst += 'Description and examples: see :ref:`%s command `\n\n' % (name, name) + rst += 'Description and examples: see :ref:`%s command `\n\n' % (name, real_name) # command syntax rst += 'Command syntax:\n\n' diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 5999b71d41..142b16b7eb 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -116,7 +116,6 @@ pygments_style = None # #html_theme = 'alabaster' html_theme = 'sphinx_rtd_theme' -#html_logo = '_static/kea-logo-100x70.png' html_logo = 'static/kea-imageonly-100bw.png' # 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'), ] +latex_logo = 'static/kea-logo-200.png' + if os.getenv("READTHEDOCS", "False") == "False": latex_documents.append((messages_doc, 'kea-messages.tex', 'Kea Messages Manual', author, 'manual')) diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index a597061167..ded3a1e99c 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -1,5 +1,9 @@ -.. figure:: static/kea-logo-200.png - :align: right +.. only:: not latex + + .. image:: static/kea-logo-200.png + :align: right + +.. _introduction: ################################## Kea Administrator Reference Manual @@ -54,12 +58,3 @@ Kea, can be found in ISC's `Knowledgebase `_. umls grammar/grammar arm/acknowledgments - - - -Indices and Tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`