diff options
| -rw-r--r-- | SECURITY.md | 4 | ||||
| -rw-r--r-- | doc-requirements.txt | 4 | ||||
| -rw-r--r-- | doc/rtd/conf.py | 1 | ||||
| -rw-r--r-- | doc/rtd/index.rst | 1 | ||||
| -rw-r--r-- | doc/rtd/topics/security.rst | 5 | ||||
| -rw-r--r-- | tox.ini | 4 |
6 files changed, 14 insertions, 5 deletions
diff --git a/SECURITY.md b/SECURITY.md index a09b1503..69360bb7 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -50,8 +50,8 @@ determined time for disclosure has arrived the following will occur: * An email is sent to the [public cloud-init mailing list](https://lists.launchpad.net/cloud-init/) The disclosure timeframe is coordinated with the reporter and members of the - cloud-init-security list. This depends on a number of factors: - +cloud-init-security list. This depends on a number of factors: + * The reporter might have their own disclosure timeline (e.g. Google Project Zero and many others use a 90-days after initial report OR when a fix becomes public) diff --git a/doc-requirements.txt b/doc-requirements.txt new file mode 100644 index 00000000..2d4ca7be --- /dev/null +++ b/doc-requirements.txt @@ -0,0 +1,4 @@ +doc8 +m2r +sphinx +sphinx_rtd_theme
\ No newline at end of file diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py index 9b274843..86441986 100644 --- a/doc/rtd/conf.py +++ b/doc/rtd/conf.py @@ -28,6 +28,7 @@ copyright = '2019, Canonical Ltd.' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + 'm2r', 'sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx.ext.viewcode', diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index 826e8c48..d2662edf 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -67,6 +67,7 @@ Having trouble? We would like to help! :caption: Development topics/hacking.rst + topics/security.rst topics/debugging.rst topics/logging.rst topics/dir_layout.rst diff --git a/doc/rtd/topics/security.rst b/doc/rtd/topics/security.rst new file mode 100644 index 00000000..b8386843 --- /dev/null +++ b/doc/rtd/topics/security.rst @@ -0,0 +1,5 @@ +.. _security: + +.. mdinclude:: ../../../SECURITY.md + +.. vi: textwidth=78 @@ -55,9 +55,7 @@ exclude = .venv,.tox,dist,doc,*egg,.git,build,tools [testenv:doc] basepython = python3 deps = - doc8 - sphinx - sphinx_rtd_theme + -r{toxinidir}/doc-requirements.txt commands = {envpython} -m sphinx {posargs:doc/rtd doc/rtd_html} doc8 doc/rtd |