From 3b32e15fe49e2992a76210f048e257cecd9c1141 Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Mon, 24 Jan 2022 17:31:21 +0700 Subject: Add Markdown support --- docs/conf.py | 3 ++- docs/copyright.md | 17 +++++++++++++++++ docs/copyright.rst | 19 ------------------- requirements.txt | 1 + 4 files changed, 20 insertions(+), 20 deletions(-) create mode 100644 docs/copyright.md delete mode 100644 docs/copyright.rst diff --git a/docs/conf.py b/docs/conf.py index 3e95e52d..e21b2a1e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,6 +46,7 @@ extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.graphviz', 'notfound.extension', 'autosectionlabel', + 'myst_parser', 'vyos' ] @@ -60,7 +61,7 @@ autosectionlabel_prefix_document = True # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] # The master toctree document. master_doc = 'index' diff --git a/docs/copyright.md b/docs/copyright.md new file mode 100644 index 00000000..670e1420 --- /dev/null +++ b/docs/copyright.md @@ -0,0 +1,17 @@ +# Copyright Notice + +Copyright (C) 2018-2022 VyOS maintainers and contributors + +Permission is granted to make and distribute verbatim copies of this manual +provided the copyright notice and this permission notice are preserved on all +copies. + +Permission is granted to copy and distribute modified versions of this manual +under the conditions for verbatim copying, provided that the entire resulting +derived work is distributed under the terms of a permission notice identical +to this one. + +Permission is granted to copy and distribute translations of this manual into +another language, under the above conditions for modified versions, except that +this permission notice may be stated in a translation approved by the VyOS +maintainers. diff --git a/docs/copyright.rst b/docs/copyright.rst deleted file mode 100644 index 551d3b26..00000000 --- a/docs/copyright.rst +++ /dev/null @@ -1,19 +0,0 @@ -################ -Copyright Notice -################ - -Copyright (C) 2018-2022 VyOS maintainers and contributors - -Permission is granted to make and distribute verbatim copies of this manual -provided the copyright notice and this permission notice are preserved on all -copies. - -Permission is granted to copy and distribute modified versions of this manual -under the conditions for verbatim copying, provided that the entire resulting -derived work is distributed under the terms of a permission notice identical -to this one. - -Permission is granted to copy and distribute translations of this manual into -another language, under the above conditions for modified versions, except that -this permission notice may be stated in a translation approved by the VyOS -maintainers. diff --git a/requirements.txt b/requirements.txt index 7bb02202..8b5ba40f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,3 +5,4 @@ docutils lxml sphinx-notfound-page docutils<0.18 +myst-parser -- cgit v1.2.3