Merge branch 'sphinx' into 'master' (d19d4f7c) · Commits · osm-doc / OSM User Guide

README.md

0 → 100644

+35 −0

Original line number	Diff line number	Diff line
		# 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 <PORT>
		```

		Then you can check the generated HTML output with a local web browser pointing to <http://localhost:PORT>

+2 −1

Original line number	Diff line number	Diff line
		@@ -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']

+1 −0