diff --git a/docs/conf.py b/docs/conf.py index d3a67d1c..eb0321a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,9 @@ 'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'sphinx_copybutton' + 'sphinx_copybutton', + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel', ] source_suffix = '.rst' master_doc = 'index' diff --git a/docs/index.rst b/docs/index.rst index 5f95ba27..2b97c6b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,3 +21,4 @@ Contents :titlesonly: contributing + security diff --git a/docs/security.rst b/docs/security.rst new file mode 100644 index 00000000..032feb60 --- /dev/null +++ b/docs/security.rst @@ -0,0 +1,34 @@ +Security Policy +=============== + +This documents the security policy and actions to take to secure the security of the package, its deployment and use. + +Supported Versions +------------------ + +Security vulnerabilities are fixed only for the latest version of `icalendar`. + +.. list-table:: Versions to receive security updates + :widths: 25 25 + :header-rows: 1 + + * - Version + - Supported + * - 6.* + - ✅ + * - 5.* + - ❌ + * - 4.* + - ❌ + * - < 4.* + - ❌ + + +Reporting a Vulnerability +------------------------- + +Please report any vulnerabilities you find on this project's +`Security Page `_. +If you cannot do this, please contact one of the +:ref:`maintainers` +directly or open an issue.