diff --git a/docs/src/autoignition.md b/docs/src/autoignition.md new file mode 100644 index 0000000..2ead1b3 --- /dev/null +++ b/docs/src/autoignition.md @@ -0,0 +1,3 @@ +# autoignition + +::: node_deployer.autoignition \ No newline at end of file diff --git a/docs/src/create_disk.md b/docs/src/create_disk.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/create_img.md b/docs/src/create_img.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yaml b/mkdocs.yaml index 21d4ed5..99f7a29 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -8,10 +8,20 @@ nav: - Getting Started: - Installation: installation.md - Usage: usage.md - - Reference: + - CLI Usage: - Commands: commands.md - Configuration: configuration.md - Deployment: deployment.md + - Reference: + - Documentation: + - autoignition: src/autoignition.md + - create_img: src/create_img.md + - create_disk: src/create_disk.md + # - FAQ: faq.md # - Troubleshooting: troubleshooting.md # - Changelog: changelog.md - # - License: license.md \ No newline at end of file + # - License: license.md + +plugins: + - search + - mkdocstrings \ No newline at end of file diff --git a/poetry.lock b/poetry.lock index 1b6106e..f6bbd65 100644 --- a/poetry.lock +++ b/poetry.lock @@ -440,6 +440,20 @@ gitdb = ">=4.0.1,<5" [package.extras] test = ["black", "coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest", "pytest-cov", "pytest-instafail", "pytest-subtests", "pytest-sugar"] +[[package]] +name = "griffe" +version = "0.36.9" +description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API." +optional = false +python-versions = ">=3.8" +files = [ + {file = "griffe-0.36.9-py3-none-any.whl", hash = "sha256:7874febe7cd81e8e47eb7b8130ff9d38c8f3656233c01d2d217d2e898a0925f5"}, + {file = "griffe-0.36.9.tar.gz", hash = "sha256:b4e510bf0ed1fc91c58453c68018a2247c561adec8f5dadc40275afc01f51eac"}, +] + +[package.dependencies] +colorama = ">=0.4" + [[package]] name = "h11" version = "0.14.0" @@ -763,6 +777,61 @@ watchdog = ">=2.0" i18n = ["babel (>=2.9.0)"] min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pathspec (==0.11.1)", "platformdirs (==2.2.0)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"] +[[package]] +name = "mkdocs-autorefs" +version = "0.5.0" +description = "Automatically link across pages in MkDocs." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocs_autorefs-0.5.0-py3-none-any.whl", hash = "sha256:7930fcb8ac1249f10e683967aeaddc0af49d90702af111a5e390e8b20b3d97ff"}, + {file = "mkdocs_autorefs-0.5.0.tar.gz", hash = "sha256:9a5054a94c08d28855cfab967ada10ed5be76e2bfad642302a610b252c3274c0"}, +] + +[package.dependencies] +Markdown = ">=3.3" +mkdocs = ">=1.1" + +[[package]] +name = "mkdocstrings" +version = "0.23.0" +description = "Automatic documentation from sources, for MkDocs." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocstrings-0.23.0-py3-none-any.whl", hash = "sha256:051fa4014dfcd9ed90254ae91de2dbb4f24e166347dae7be9a997fe16316c65e"}, + {file = "mkdocstrings-0.23.0.tar.gz", hash = "sha256:d9c6a37ffbe7c14a7a54ef1258c70b8d394e6a33a1c80832bce40b9567138d1c"}, +] + +[package.dependencies] +Jinja2 = ">=2.11.1" +Markdown = ">=3.3" +MarkupSafe = ">=1.1" +mkdocs = ">=1.2" +mkdocs-autorefs = ">=0.3.1" +mkdocstrings-python = {version = ">=0.5.2", optional = true, markers = "extra == \"python\""} +pymdown-extensions = ">=6.3" + +[package.extras] +crystal = ["mkdocstrings-crystal (>=0.3.4)"] +python = ["mkdocstrings-python (>=0.5.2)"] +python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"] + +[[package]] +name = "mkdocstrings-python" +version = "1.7.3" +description = "A Python handler for mkdocstrings." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocstrings_python-1.7.3-py3-none-any.whl", hash = "sha256:2439d6ad3e34f0bb4c643b845fb3c06ae9233499a1736f9fa273424b75cc5894"}, + {file = "mkdocstrings_python-1.7.3.tar.gz", hash = "sha256:c20128fa96c24dbc6437b10dfedaf33b0415d4503e51ce9ce5e84b271278268e"}, +] + +[package.dependencies] +griffe = ">=0.35" +mkdocstrings = ">=0.20" + [[package]] name = "mypy" version = "1.6.1" @@ -910,6 +979,24 @@ files = [ [package.extras] plugins = ["importlib-metadata"] +[[package]] +name = "pymdown-extensions" +version = "10.3.1" +description = "Extension pack for Python Markdown." +optional = false +python-versions = ">=3.8" +files = [ + {file = "pymdown_extensions-10.3.1-py3-none-any.whl", hash = "sha256:8cba67beb2a1318cdaf742d09dff7c0fc4cafcc290147ade0f8fb7b71522711a"}, + {file = "pymdown_extensions-10.3.1.tar.gz", hash = "sha256:f6c79941498a458852853872e379e7bab63888361ba20992fc8b4f8a9b61735e"}, +] + +[package.dependencies] +markdown = ">=3.2" +pyyaml = "*" + +[package.extras] +extra = ["pygments (>=2.12)"] + [[package]] name = "pysocks" version = "1.7.1" @@ -1372,4 +1459,4 @@ h11 = ">=0.9.0,<1" [metadata] lock-version = "2.0" python-versions = "^3.12" -content-hash = "96a0d1f0c03c7170d98e6ccb0a676213589ce4870e3904927cc3dc4c36323d76" +content-hash = "928828e0aced77a627487120700ec1db6f94648d35ff77c96e377b1c74e0e5de" diff --git a/pyproject.toml b/pyproject.toml index edebc77..578c626 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,9 +1,11 @@ [tool.poetry] name = "i-form-server-node-deployer" version = "0.1.0" -description = "" +description = "A tool for automatically deploying nodes in a cluster server for research environments." +urls={github = "https://github.com/Cian-H/I-Form_Server_Node_Deployer"} authors = ["Cian Hughes "] readme = "README.md" +license = "MIT" packages = [ {include = "node_deployer", from = "src"}, ] @@ -29,6 +31,7 @@ docker-stubs = {git = "https://github.com/rdozier-work/docker-stubs"} [tool.poetry.group.docs.dependencies] mkdocs = "^1.5.3" +mkdocstrings = {extras = ["python"], version = "^0.23.0"} [tool.poetry.scripts] node_deployer = "node_deployer.__main__:main"