From 6757a6d2a900465aec5187a0dc9ce1df4e23445d Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Fri, 13 Dec 2019 11:57:17 +0100 Subject: [PATCH 1/2] Added required extension form MD tables with Sphinx Signed-off-by: garciadeblas --- conf.py | 3 ++- requirements.txt | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 8b903e4..a62ede3 100644 --- a/conf.py +++ b/conf.py @@ -36,6 +36,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', 'recommonmark', + 'sphinx_markdown_tables', ] source_suffix = { @@ -53,7 +54,7 @@ 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 = ['_build', 'TO-BE-MOVED-TO-OTHER-REPOS', 'Thumbs.db', '.DS_Store', +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md', 'navigation.md', 'index.md', 'requirements.txt'] diff --git a/requirements.txt b/requirements.txt index 315fad4..e5fa376 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ sphinx sphinx_rtd_theme sphinxcontrib-versioning recommonmark +sphinx-markdown-tables -- GitLab From 4c0cbd0c2dc46301eee2fbd7b483cd49b95f09a1 Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Fri, 13 Dec 2019 12:00:12 +0100 Subject: [PATCH 2/2] Added README.md Signed-off-by: garciadeblas --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1bd3cfe --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# OSM User Guide + +## Scope of the document + +This document collects Open Source MANO User Guide. + +## Guidelines for contributors + +* OSM [Workflow for documentation production](https://osm.etsi.org/gitlab/osm-doc/documentation-how-to/blob/master/Workflow%20for%20documentation%20production%20in%20OSM.md#guide-for-contributors) must be used. +* Every section of this document, under a "H1" tag (single #), must be contained in a single file and formatted according to the following [sample document](#) + +## Exporting the document to HTML + +This markdown format can be easily exported by installing and using [Sphinx](http://www.sphinx-doc.org/en/master/) in your local machine. + +Install the required packages: + +```bash +sudo -H python3 -m pip install -r requirements.txt +``` + +Then run: + +```bash +make html +``` + +The generated HTML output is stored in `_build/html`. You can go to that folder and publish the content locally with a Simple HTTP Server in Python. + +```bash +python3 -m http.server +``` + +Then you can check the generated HTML output with a local web browser pointing to + -- GitLab