diff --git a/docs/source/basic-tools.rst b/docs/source/basic-tools.rst new file mode 100644 index 0000000000000000000000000000000000000000..484dd749d7b27fce12f7c67862643f73583ba452 --- /dev/null +++ b/docs/source/basic-tools.rst @@ -0,0 +1,6 @@ +.. list of basic cli tools + +CLI Tools +========================= + +.. automodule:: resource_management.cli diff --git a/docs/source/conf.py b/docs/source/conf.py index 0f7ee5f03821e3e863233c4fff1b68981e2d6a9b..990f58aa5b5a2b24776500d4a0f9142a7b05b2d1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -58,7 +58,8 @@ author = 'GN5' extensions = [ 'sphinx_rtd_theme', 'sphinx.ext.autodoc', - 'sphinx.ext.coverage' + 'sphinx.ext.coverage', + 'sphinx.ext.todo' ] templates_path = ['_templates'] @@ -78,3 +79,6 @@ html_static_path = ['_static'] autoclass_content = 'both' autodoc_typehints = 'none' +# Display todos by setting to True +todo_include_todos = True + diff --git a/docs/source/index.rst b/docs/source/index.rst index 6f1389e6b33ad1288ccb8ddfb52b7e6eb7a90bb3..2694d74b9cdb21bbe3f8a2ea37add97c8b5eb1af 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,13 +3,22 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to NAT Resource Management's documentation! -=================================================== +NAT Resource Management +========================== + +Documentation for the NAT Resource Management tools + +------------------ + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: + basic-tools + + + Indices and tables diff --git a/resource_management/cli.py b/resource_management/cli.py index 53fc372388694b1a94903c4f46955314241faf9e..f6a6a00e9eb39fa9f55faeaf1045ea685ec3b80e 100644 --- a/resource_management/cli.py +++ b/resource_management/cli.py @@ -1,3 +1,33 @@ +""" + +script name [TODO] +==================== + +.. code-block:: bash + + Usage: script name [OPTIONS] + + notes: - first call init_db(dns=mysql_dsn(params from config)) - then create + a session (as in unit test) - ... and perform the db queries + + Options: + --config FILENAME config filename [required] + --fqdn TEXT config filename [required] + --help Show this message and exit. + +The configuration filename must be formatted according +to this schema: + + .. asjson:: + resource_management.config.CONFIG_SCHEMA + + +.. todo:: + + add a console script alias and change the name (cli.py) below + + +""" import json import click