diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/api/item_types.rst | 2 | ||||
-rw-r--r-- | doc/source/conf.py | 18 | ||||
-rw-r--r-- | doc/source/development.rst | 6 | ||||
-rw-r--r-- | doc/source/index.rst | 8 | ||||
-rw-r--r-- | doc/source/internal.rst | 4 | ||||
-rw-r--r-- | doc/source/requirements.txt | 52 | ||||
-rw-r--r-- | doc/source/standard_conformance.rst (renamed from doc/source/rfc_conformance.rst) | 6 |
7 files changed, 44 insertions, 52 deletions
diff --git a/doc/source/api/item_types.rst b/doc/source/api/item_types.rst index 1452b3e5f90e..1051b97ded7b 100644 --- a/doc/source/api/item_types.rst +++ b/doc/source/api/item_types.rst @@ -1,7 +1,7 @@ Types of items =============================================== -Every :type:`cbor_item_t` has a :type:`cbor_type` associated with it - these constants correspond to the types specified by the `CBOR standard <http://tools.ietf.org/html/rfc7049>`_: +Every :type:`cbor_item_t` has a :type:`cbor_type` associated with it - these constants correspond to the types specified by the `CBOR standard <https://www.rfc-editor.org/info/std94>`_: .. doxygenenum:: cbor_type diff --git a/doc/source/conf.py b/doc/source/conf.py index 585efc8a436f..0eee7103bb5a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -33,7 +33,8 @@ extensions = [ 'breathe', 'sphinx.ext.mathjax', 'sphinx.ext.autodoc', - 'sphinx.ext.ifconfig' + 'sphinx.ext.ifconfig', + 'sphinx_rtd_theme' ] import subprocess, os @@ -76,8 +77,8 @@ copyright = '2014 - 2020, Pavel Kalvoda' # built documents. # # The short X.Y version. -version = '0.10' -release = '0.10.2' +version = '0.11' +release = '0.11.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -127,7 +128,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -285,12 +286,3 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - - -if not on_rtd: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# otherwise, readthedocs.org uses their theme by default, so no need to specify it - diff --git a/doc/source/development.rst b/doc/source/development.rst index 13e91ef25762..0b0ac21007ed 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -22,15 +22,15 @@ everywhere. Goals ~~~~~~~~~~~~~~~~~~~~~~ -RFC-conformance and full feature support -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Standard conformance and full feature support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Anything the standard allows, libcbor can do. **Why?** Because conformance and interoperability is the point of defining standards. Clients expect the support to be feature-complete and there is no significant complexity reduction that can be achieved by slightly -cutting corners, which means that the incremental cost of full RFC support is +cutting corners, which means that the incremental cost of full [CBOR standard](https://www.rfc-editor.org/info/std94) support is comparatively small over "almost-conformance" seen in many alternatives. diff --git a/doc/source/index.rst b/doc/source/index.rst index 79293e798c3b..d3d62cf75c41 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,7 +9,7 @@ Overview Main features - - Complete RFC conformance [#]_ + - Complete `IETF RFC 8949 (STD 94) <https://www.rfc-editor.org/info/std94>`_ conformance [#]_ - Robust C99 implementation - Layered architecture offers both control and convenience - Flexible memory management @@ -19,7 +19,7 @@ Main features - Extensive documentation and test suite - No runtime dependencies, small footprint -.. [#] See :doc:`rfc_conformance` +.. [#] See :doc:`standard_conformance` .. [#] With the exception of custom memory allocators (see :doc:`api/item_reference_counting`) @@ -31,9 +31,9 @@ Contents using api tests - rfc_conformance + standard_conformance internal changelog development -.. _CBOR: http://tools.ietf.org/html/rfc7049 +.. _CBOR: https://www.rfc-editor.org/info/std94 diff --git a/doc/source/internal.rst b/doc/source/internal.rst index 2c62a82b2329..e30cb11dffa1 100644 --- a/doc/source/internal.rst +++ b/doc/source/internal.rst @@ -6,7 +6,7 @@ Internal workings of *libcbor* are mostly derived from the specification. The pu Terminology --------------- === ====================== ======================================================================================================================================== -MTB Major Type Byte http://tools.ietf.org/html/rfc7049#section-2.1 +MTB Major Type Byte https://www.rfc-editor.org/rfc/rfc8949.html#section-3.1 --- ---------------------- ---------------------------------------------------------------------------------------------------------------------------------------- DST Dynamically Sized Type Type whose storage requirements cannot be determined @@ -32,7 +32,7 @@ and also borrowing from General notes on the API design -------------------------------- -The API design has two main driving priciples: +The API design has two main driving principles: 1. Let the client manage the memory as much as possible 2. Behave exactly as specified by the standard diff --git a/doc/source/requirements.txt b/doc/source/requirements.txt index a82e34e58ad2..502d79cc62e6 100644 --- a/doc/source/requirements.txt +++ b/doc/source/requirements.txt @@ -1,31 +1,31 @@ -alabaster==0.7.12 -Babel==2.9.1 -breathe==4.33.1 -certifi==2022.12.7 -charset-normalizer==2.0.12 -colorama==0.4.4 -docutils==0.17.1 -idna==3.3 -imagesize==1.3.0 -importlib-metadata==4.11.3 -Jinja2==3.0.3 +alabaster==0.7.13 +Babel==2.13.1 +breathe==4.35.0 +certifi==2023.11.17 +charset-normalizer==3.3.2 +colorama==0.4.6 +docutils==0.18.1 +idna==3.4 +imagesize==1.4.1 +importlib-metadata==6.8.0 +Jinja2==3.1.2 livereload==2.6.3 -MarkupSafe==2.1.1 -packaging==21.3 -Pygments==2.11.2 -pyparsing==3.0.7 +MarkupSafe==2.1.3 +packaging==23.2 +Pygments==2.16.1 +pyparsing==3.1.1 pytz==2021.3 -requests==2.27.1 +requests==2.31.0 snowballstemmer==2.2.0 -Sphinx==4.4.0 +Sphinx==7.2.6 sphinx-autobuild==2021.3.14 -sphinx-rtd-theme==1.0.0 -sphinxcontrib-applehelp==1.0.2 -sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-htmlhelp==2.0.0 +sphinx-rtd-theme==1.3.0 +sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-devhelp==1.0.5 +sphinxcontrib-htmlhelp==2.0.4 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -tornado==6.1 -urllib3==1.26.9 -zipp==3.7.0 +sphinxcontrib-qthelp==1.0.6 +sphinxcontrib-serializinghtml==1.1.9 +tornado==6.3.3 +urllib3==2.1.0 +zipp==3.17.0 diff --git a/doc/source/rfc_conformance.rst b/doc/source/standard_conformance.rst index 6848fbacd464..62965f0c4493 100644 --- a/doc/source/rfc_conformance.rst +++ b/doc/source/standard_conformance.rst @@ -1,13 +1,13 @@ -RFC conformance +IETF standard conformance ========================= -*libcbor* is, generally speaking, very faithful implementation of `RFC 7049 <https://tools.ietf.org/html/rfc7049>`_. There are, however, some limitations imposed by technical constraints. +*libcbor* is, generally speaking, a very faithful implementation of `IETF RFC 8949 (STD 94) <https://www.rfc-editor.org/info/std94>`_. There are, however, some limitations related to the numerical range and precision available in portable C99. Bytestring length ------------------- There is no explicit limitation of indefinite length byte strings. [#]_ *libcbor* will not handle byte strings with more chunks than the maximum value of :type:`size_t`. On any sane platform, such string would not fit in the memory anyway. It is, however, possible to process arbitrarily long strings and byte strings using the streaming decoder. -.. [#] https://tools.ietf.org/html/rfc7049#section-2.2.2 +.. [#] https://www.rfc-editor.org/rfc/rfc8949.html#section-3.2.3 "Half-precision" IEEE 754 floats --------------------------------- |