ci: replace Travis with GitHub Actions
Minor cleanups in docs and build scripts
Change-Id: Icfab337d1b9c78f91ea0c47b65eb4dae6d589b18
diff --git a/docs/conf.py b/docs/conf.py
index 1cf79b2..e88e6bf 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'NAC: Name-based Access Control library'
-copyright = u'Copyright © 2014-2020 Regents of the University of California.'
+copyright = u'Copyright © 2014-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,7 +38,7 @@
# 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
@@ -87,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 ------------------------------------------------
diff --git a/docs/doxygen.conf.in b/docs/doxygen.conf.in
index 155eeb5..11b3e2e 100644
--- a/docs/doxygen.conf.in
+++ b/docs/doxygen.conf.in
@@ -1640,16 +1640,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.
diff --git a/docs/index.rst b/docs/index.rst
index ecf8f81..0cd704e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,14 +1,14 @@
NAC: Name-Based Access Control
==============================
-NAC is a C++ library, implementing Name-Based Access control primitives that can be
-used to implement content confidentiality in NDN applications.
+NAC is a C++ library providing Name-Based Access control primitives that
+can be used to implement content confidentiality in NDN applications.
-Please submit any bugs or issues to the `NAC issue tracker
-<http://redmine.named-data.net/projects/nac/issues>`__.
+Please submit any bug reports or feature requests to the `NAC issue tracker
+<https://redmine.named-data.net/projects/nac/issues>`__.
-NAC Documentation
----------------------
+Documentation
+-------------
.. toctree::
:hidden:
@@ -17,13 +17,10 @@
spec
- :doc:`spec`
-
-**Additional documentation**
-
- `API documentation (doxygen) <doxygen/annotated.html>`_
License
-------
-NAC is an open source project licensed under LGPL 3.0 license. For more information about
+NAC is an open source project licensed under the LGPL version 3. For more information about
the license, refer to `COPYING.md <https://github.com/named-data/name-based-access-control/blob/master/COPYING.md>`_.
diff --git a/docs/spec.rst b/docs/spec.rst
index 659cde5..bb706f3 100644
--- a/docs/spec.rst
+++ b/docs/spec.rst
@@ -59,7 +59,7 @@
.. code-block:: abnf
Kek = DATA-TYPE TLV-LENGTH
- Name ; /[access-namespace]/NAC/[dataset]/KEK/[key-id]
+ Name ; /[access-namespace]/NAC/[dataset]/KEK/[key-id]
MetaInfo ; ContentType = KEY, FreshnessPeriod = 1 hour default value
KekContent
DataSignature
@@ -73,7 +73,7 @@
.. code-block:: abnf
Kdk = DATA-TYPE TLV-LENGTH
- Name ; /[access-namespace]/NAC/[dataset]/KDK/[key-id]/ENCRYPTED-BY/<authorized-member>/KEY/[member-key-id]
+ Name ; /[access-namespace]/NAC/[dataset]/KDK/[key-id]/ENCRYPTED-BY/<authorized-member>/KEY/[member-key-id]
MetaInfo ; ContentType = BLOB, FreshnessPeriod = 1 hour default value
KdkContent
DataSignature
@@ -83,7 +83,7 @@
Within the ``EncryptedContent`` element,
-* ``EncryptedPayload`` contains `SafeBag <https://named-data.net/doc/ndn-cxx/0.7.0/specs/safe-bag.html>`__ of private key ``/[access-namespace]/NAC/[dataset]/KEY/[key-id]``
+* ``EncryptedPayload`` contains `SafeBag <https://named-data.net/doc/ndn-cxx/0.7.1/specs/safe-bag.html>`__ of private key ``/[access-namespace]/NAC/[dataset]/KEY/[key-id]``
* ``EncryptedPayloadKey`` contains password for SafeBag, encrypted by public key ``/<authorized-member>/KEY/[member-key-id]``
* ``InitializationVector`` and ``Name`` must be omitted
@@ -100,7 +100,7 @@
EncryptedPayload = AES CBC encrypted blob
InitializationVector = Random initial vector for AES CBC encryption
- EncryptedPayloadKey (not set)
+ EncryptedPayloadKey (not set)
Name = Prefix of ContentKey (CK) data packet /[ck-prefix]/CK/[ck-id]
During initialization or when requested by the application, the Encryptor (re-)generates a random key for AES CBC encryption.
@@ -109,7 +109,7 @@
.. code-block:: abnf
CkData = DATA-TYPE TLV-LENGTH
- Name ; /[ck-prefix]/CK/[ck-id]/ENCRYPTED-BY/[access-namespace]/NAC/[dataset]/KEK/[key-id]
+ Name ; /[ck-prefix]/CK/[ck-id]/ENCRYPTED-BY/[access-namespace]/NAC/[dataset]/KEK/[key-id]
MetaInfo ; ContentType = BLOB, FreshnessPeriod = 1 hour default value
CkContent
DataSignature