Code autogenerated from Kurento/doc-kurento@50fb44b

Makefile

@@ -15,7 +15,8 @@ $(error This Make doesn't support '.ONESHELL', use Make >= 3.82)
 endif
 
 # You can set these variables from the command line.
-SPHINXOPTS  :=
+# Adding more '-v' increases the log verbosity level.
+SPHINXOPTS  := -v
 SPHINXBUILD := sphinx-build
 SPHINXPROJ  := Kurento
 SOURCEDIR   := source
@@ -41,8 +42,8 @@ help:
 	@echo "- texlive-latex-extra"
 	@echo ""
 	@echo "python pip dependencies:"
-	@echo "- sphinx >= 1.5.0 (Tested: 1.6.6)"
-	@echo "- sphinx_rtd_theme"
+	@echo "- sphinx >= 1.5.0 (Tested: 3.3.0)"
+	@echo "- sphinx_rtd_theme  (Tested: 0.5.0)"
 
 init-workdir:
 	mkdir -p $(WORKDIR)
@@ -62,7 +63,7 @@ langdoc-client-java: langdoc-init
 	cd $(WORKPATH)
 	git clone https://github.com/Kurento/kurento-java.git
 	cd kurento-java
-	[ "true" = "true" ] && git checkout "6.15.0"
+	[ "false" = "true" ] && git checkout "6.15.0"
 	cd kurento-client || { echo "ERROR: 'cd' failed, ls:"; ls -lA; exit 1; }
 	mvn --batch-mode --quiet clean package \
 		-DskipTests || { echo "ERROR: 'mvn clean' failed"; exit 1; }
@@ -76,7 +77,7 @@ langdoc-client-js: langdoc-init
 	cd $(WORKPATH)
 	git clone https://github.com/Kurento/kurento-client-js.git
 	cd kurento-client-js
-	[ "true" = "true" ] && git checkout "6.15.0"
+	[ "false" = "true" ] && git checkout "6.15.0"
 	npm install --no-color
 	node_modules/.bin/grunt --no-color --force jsdoc \
 		|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }
@@ -86,7 +87,7 @@ langdoc-utils-js: langdoc-init
 	cd $(WORKPATH)
 	git clone https://github.com/Kurento/kurento-utils-js.git
 	cd kurento-utils-js
-	[ "true" = "true" ] && git checkout "6.15.0"
+	[ "false" = "true" ] && git checkout "6.15.0"
 	npm install --no-color
 	node_modules/.bin/grunt --no-color --force jsdoc \
 		|| { echo "ERROR: 'grunt jsdoc' failed"; exit 1; }

README.md

@@ -16,17 +16,17 @@ Copyright 2018 [Kurento]. Licensed under [Apache 2.0 License].
 doc-kurento
 ===========
 
-Kurento Documentation. Made with [Sphinx] and [Read The Docs].
+Kurento Documentation. Made with [Sphinx] and [Read the Docs].
 
-[Sphinx]: http://www.sphinx-doc.org
-[Read The Docs]: https://docs.readthedocs.io
+[Sphinx]: https://www.sphinx-doc.org/
+[Read the Docs]: https://docs.readthedocs.io
 
 
 
 About Kurento
 =============
 
-Kurento is an open source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: https://www.kurento.org/.
+Kurento is an Open Source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: https://www.kurento.org/.
 
 Kurento is part of [FIWARE]. For further information on the relationship of FIWARE and Kurento check the [Kurento FIWARE Catalog Entry]. Kurento is also part of the [NUBOMEDIA] research initiative.
 
@@ -52,14 +52,14 @@ Useful Links
 
 Usage:
 
-* [Installation Guide](https://doc-kurento.readthedocs.io/en/stable/user/installation.html)
-* [Compilation Guide](https://doc-kurento.readthedocs.io/en/stable/dev/dev_guide.html#developing-kms)
-* [Contribution Guide](https://doc-kurento.readthedocs.io/en/stable/project/contributing.html)
+* [Installation Guide](https://doc-kurento.readthedocs.io/en/latest/user/installation.html)
+* [Compilation Guide](https://doc-kurento.readthedocs.io/en/latest/dev/dev_guide.html#developing-kms)
+* [Contribution Guide](https://doc-kurento.readthedocs.io/en/latest/project/contributing.html)
 
 Issues:
 
 * [Bug Tracker](https://github.com/Kurento/bugtracker/issues)
-* [Support](https://doc-kurento.readthedocs.io/en/stable/user/support.html)
+* [Support](https://doc-kurento.readthedocs.io/en/latest/user/support.html)
 
 News:
 

VERSIONS.conf.sh

@@ -33,7 +33,7 @@ declare -A PROJECT_VERSIONS=(
     # Indicates if the current state of this code is Release or Nightly.
     # If "true", all mentioned repos will be checked out to the corresponding
     # versions; otherwise, they will be kept at the default branch (master).
-    [VERSION_RELEASE]="true"
+    [VERSION_RELEASE]="false"
 )
 
 # If the build is not for a release, then some versions can be set to more

requirements.txt

@@ -0,0 +1,4 @@
+# pip3 install -r requirements.txt
+
+sphinx == 3.3.0
+sphinx-rtd-theme == 0.5.0

source/_static/README.txt

@@ -1,7 +1,7 @@
 File: footer-european-union-400-optimized.png
 Source:
   Logo & graphic design
-  http://ec.europa.eu/regional_policy/en/information/logos/
+  https://ec.europa.eu/regional_policy/en/information/logos/
   -> Download example of logos (en)
 Changes: Resized to 400x77 px with IrfanView. Saved to PNG with PNGOUT optimization plugin.
 

source/conf.py

@@ -1,52 +1,61 @@
-# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
 #
-# PyLint: Disable false positives (IDs from `pylint --list-msgs`)
-# pylint: disable=invalid-name
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-"""
-Kurento documentation build configuration file, created by
-sphinx-quickstart on Tue Jan 14 01:23:07 2014.
+import sphinx_rtd_theme
 
-This file is execfile()d with the current directory set to its
-containing dir.
 
-Note that not all possible configuration values are present in this
-autogenerated file.
+# -- Path setup -----------------------------------------------------------
 
-All configuration values have a default; values that are commented out
-serve to show the default.
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('extensions'))
 
-If extensions (or modules to document with autodoc) are in another directory,
-add these directories to sys.path here. If the directory is relative to the
-documentation root, use os.path.abspath to make it absolute, like shown here.
-"""
 
-import os
-import sys
-sys.path.insert(0, os.path.abspath('.'))
+# -- Project information --------------------------------------------------
 
+project = 'Kurento'
+copyright = '2020, Kurento'
+author = 'Kurento'
 
-# -- General configuration ------------------------------------------------
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+# The short X.Y version.
+version = '6.15.0'
+
+# The full version, including alpha/beta/rc tags.
+release = version
+
+
+# -- General configuration ------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-sys.path.append(os.path.abspath('extensions'))
 extensions = [
+    'sphinx.ext.extlinks',
     'sphinx.ext.graphviz',
     'sphinx.ext.ifconfig',
-    'sphinx.ext.todo',
-    'wikipedia',
-    'examplecode'
+    'sphinx_rtd_theme',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -56,33 +65,13 @@
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = u'Kurento'
-copyright = u'2018, Kurento'  # pylint: disable=redefined-builtin
-author = u'Kurento'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '6.15.0'
-
-# The full version, including alpha/beta/rc tags.
-release = version
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 language = 'en'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
-
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -93,11 +82,10 @@
 # their width to the available space (overflows the paragraph size).
 graphviz_output_format = 'png'
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
-# Default language for Wikipedia articles. Default: 'en'.
-wikipedia_lang = 'en'  # English
+# Add English Wikipedia as an external site role.
+extlinks = {
+    'wikipedia': ('https://en.wikipedia.org/wiki/%s', 'Wikipedia: ')
+}
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -116,6 +104,9 @@
     'display_version': True
 }
 
+# Force the "Edit on GitHub" button to use this URL.
+github_url = 'https://github.com/Kurento/doc-kurento'
+
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 html_logo = 'images/kurento-white.png'
@@ -125,10 +116,9 @@
 # pixels large.
 html_favicon = 'images/favicon.ico'
 
-# A list of paths that contain custom static files (such as style sheets or
-# script files). Relative paths are taken as relative to the configuration
-# directory. They are copied to the output's _static directory after the theme's
-# static files, so a file named default.css will overwrite the theme's default.css.
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static', 'langdoc']
 
 

source/dev/dev_guide.rst

@@ -42,7 +42,7 @@ As the dependency graph is not strictly linear, there are multiple possible ways
 
 **Fork repositories**:
 
-KMS depends on several open source libraries, the main one being GStreamer. Sometimes these libraries show specific behaviors that need to be tweaked in order to be useful for KMS; other times there are bugs that have been fixed but the patch is not accepted at the upstream source for whatever reason. In these situations, while the official path of feature requests and/or patch submit is still tried, we have created a fork of the affected libraries.
+KMS depends on several Open Source libraries, the main one being GStreamer. Sometimes these libraries show specific behaviors that need to be tweaked in order to be useful for KMS; other times there are bugs that have been fixed but the patch is not accepted at the upstream source for whatever reason. In these situations, while the official path of feature requests and/or patch submit is still tried, we have created a fork of the affected libraries.
 
 - `jsoncpp <https://github.com/Kurento/jsoncpp>`__
 - `libsrtp <https://github.com/Kurento/libsrtp>`__

source/dev/hardening.rst

@@ -84,7 +84,7 @@ Now follows some examples of applying these rules into an hypothetical project c
    `Options for Linking <https://gcc.gnu.org/onlinedocs/gcc-7.2.0/gcc/Link-Options.html>`__
        See *-shared*, *-pie*.
 
-   `dpkg-buildflags <http://man7.org/linux/man-pages/man1/dpkg-buildflags.1.html>`__
+   `dpkg-buildflags <https://man7.org/linux/man-pages/man1/dpkg-buildflags.1.html>`__
        See *FEATURE AREAS* > *hardening* > *pie*.
 
 
@@ -123,7 +123,7 @@ It would be nice if CMake took over the whole process of generating valid PIC/PI
 .. [#Ubuntu] https://wiki.ubuntu.com/Security/Features#Userspace_Hardening
 
 .. [#format] https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
-.. [#fortify] http://man7.org/linux/man-pages/man7/feature_test_macros.7.html
+.. [#fortify] https://man7.org/linux/man-pages/man7/feature_test_macros.7.html
 .. [#stack] https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html
 .. [#pie] https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html