diff options
| author | Joshua Powers <josh.powers@canonical.com> | 2019-12-06 12:41:40 -0800 |
|---|---|---|
| committer | Daniel Watkins <oddbloke@ubuntu.com> | 2019-12-06 15:41:39 -0500 |
| commit | bbd9ef9f5dc9b3728d0d10534bf5d8b372bd1641 (patch) | |
| tree | 95197246df81b77b4467f05ac024119da35aa3de /doc/rtd | |
| parent | f1094b1a539044c0193165a41501480de0f8df14 (diff) | |
| download | vyos-cloud-init-bbd9ef9f5dc9b3728d0d10534bf5d8b372bd1641.tar.gz vyos-cloud-init-bbd9ef9f5dc9b3728d0d10534bf5d8b372bd1641.zip | |
docs: Add security.md to readthedocs
* docs: Add security.md to readthedocs
This enables the ability to show the security policy on both GitHub and
on the readthedocs site. To do this, enable the ability to import
Markdown based files and translate them to rst.
* Add doc-requirements.txt and update tox to use
Also removes the extra, uncessary extension addition of .md
Diffstat (limited to 'doc/rtd')
| -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 |
3 files changed, 7 insertions, 0 deletions
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 |