Skip to content
Snippets Groups Projects
Verified Commit f1a84961 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

Add docstrings to generated documentation

Ignores lso.app since it causes an error, and doesn't contain anything useful
parent c15f13b9
Branches
Tags
1 merge request!10Add docstrings to generated documentation
python docs/dump-openapi-spec.py python docs/dump-openapi-spec.py
sphinx-apidoc lso lso/app.py -o docs/source -d 2 -f
sphinx-build -b html docs/source docs/build sphinx-build -b html docs/source docs/build
...@@ -19,7 +19,7 @@ import sys ...@@ -19,7 +19,7 @@ import sys
sys.path.insert(0, os.path.abspath( sys.path.insert(0, os.path.abspath(
os.path.join( os.path.join(
os.path.dirname(__file__), os.path.dirname(__file__),
'..', '..', 'resource_management'))) '..', '..', 'lso')))
class RenderAsJSON(Directive): class RenderAsJSON(Directive):
......
...@@ -8,6 +8,7 @@ Documentation for LSO: a Lightweight Service Orchestrator ...@@ -8,6 +8,7 @@ Documentation for LSO: a Lightweight Service Orchestrator
:caption: Contents: :caption: Contents:
quickstart quickstart
modules
`Swagger API Docs <_static/openapi.html>`__ `Swagger API Docs <_static/openapi.html>`__
...@@ -40,7 +40,7 @@ def load_from_file(file): ...@@ -40,7 +40,7 @@ def load_from_file(file):
Input is validated against this jsonschema: Input is validated against this jsonschema:
.. asjson:: resource_management.config.CONFIG_SCHEMA .. asjson:: lso.config.CONFIG_SCHEMA
:param file: file-like object that produces the config file :param file: file-like object that produces the config file
:return: a dict containing the parsed configuration parameters :return: a dict containing the parsed configuration parameters
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment