Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Sphinx doc added #1161

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions infrastructure-provisioning/scripts/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Minimal makefile for Sphinx documentation

.PHONY: install-deps
install-deps:
pip install --requirement ../../requirements.txt

.PHONY: doc
doc:
set -e; make install-deps
sphinx-build -c ./sphinx -T -a -b singlehtml . ./docs
316 changes: 316 additions & 0 deletions infrastructure-provisioning/scripts/deploy_datalab.py

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions infrastructure-provisioning/scripts/deploy_datalab.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Self-Service Node deployment script
***********************
.. sphinx_argparse_cli::
:module: deploy_datalab
:prog: deploy_datalab
:func: build_parser
:usage_width: 100

Examples
***********************
.. automodule:: deploy_datalab
:no-undoc-members:
4 changes: 4 additions & 0 deletions infrastructure-provisioning/scripts/docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9ec73487af7d986a4a92697d0e2eb884
tags: 33eac41acc08762151beb8f3b7b86c8f
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading