ci: replace Travis with GitHub Actions
Sync docs/conf.py with ndn-cxx
Change-Id: I2c7106ef52a0e7c00de6767c6b59dbd3ce1dc082
diff --git a/docs/conf.py b/docs/conf.py
index 5fa4789..05d0f76 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,10 +1,8 @@
-# -*- coding: utf-8 -*-
-#
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
@@ -20,13 +18,13 @@
# -- Project information -----------------------------------------------------
project = u'ChronoSync: A Synchronization Protocol for NDN'
-copyright = u'Copyright © 2012-2020 Regents of the University of California.'
+copyright = u'Copyright © 2012-2021 Regents of the University of California.'
author = u'Named Data Networking Project'
-# The short X.Y version
+# The short X.Y version.
#version = ''
-# The full version, including alpha/beta/rc tags
+# The full version, including alpha/beta/rc tags.
#release = ''
# There are two options for replacing |today|: either, you set today to some
@@ -40,12 +38,13 @@
# If your documentation needs a minimal Sphinx version, state it here.
#
-needs_sphinx = '1.1'
+needs_sphinx = '1.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ 'sphinx.ext.extlinks',
'sphinx.ext.todo',
]
@@ -86,6 +85,12 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+html_copy_source = False
+html_show_sourcelink = False
+
+# Disable syntax highlighting of code blocks by default.
+highlight_language = 'none'
+
# -- Options for LaTeX output ------------------------------------------------
@@ -132,3 +137,7 @@
doxylink = {
'ChronoSync': ('ChronoSync.tag', 'doxygen/'),
}
+
+extlinks = {
+ 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #'),
+}
diff --git a/docs/doxygen.conf.in b/docs/doxygen.conf.in
index 7a5922d..7a74246 100644
--- a/docs/doxygen.conf.in
+++ b/docs/doxygen.conf.in
@@ -1041,13 +1041,6 @@
ALPHABETICAL_INDEX = YES
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX = 5
-
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -1746,16 +1739,6 @@
LATEX_HIDE_INDICES = NO
-# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
-# code with syntax highlighting in the LaTeX output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_SOURCE_CODE = NO
-
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
@@ -1828,16 +1811,6 @@
RTF_EXTENSIONS_FILE =
-# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
-# with syntax highlighting in the RTF output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_SOURCE_CODE = NO
-
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
@@ -1927,15 +1900,6 @@
DOCBOOK_OUTPUT = docbook
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
@@ -2044,11 +2008,16 @@
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = DOXYGEN \
+ NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(x)= \
+ NDN_LOG_INIT(x)= \
+ NDN_LOG_MEMBER_DECL()= \
+ NDN_LOG_MEMBER_DECL_SPECIALIZED(x)= \
+ NDN_LOG_MEMBER_INIT(x,y)= \
+ NDN_LOG_MEMBER_INIT_SPECIALIZED(x,y)= \
CHRONOSYNC_PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
CHRONOSYNC_PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
CHRONOSYNC_PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
- CHRONOSYNC_VIRTUAL_WITH_TESTS= \
- NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(x)=
+ CHRONOSYNC_VIRTUAL_WITH_TESTS=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
diff --git a/docs/index.rst b/docs/index.rst
index 872ace5..bdd22a2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,15 +8,12 @@
DesignDoc
* :doc:`DesignDoc`
-
-**Additional documentation**
-
* `API documentation (doxygen) <doxygen/annotated.html>`_
Downloading
-----------
-* `Source code GitHub git repository <https://github.com/named-data/ChronoSync>`_.
+* `Source code git repository <https://github.com/named-data/ChronoSync>`_
License
-------