From c089301f79dab9bdd35e2d0343a640adb36cf040 Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Sat, 11 Apr 2015 16:28:22 +0200 Subject: [PATCH] Generate task graph data through sphinx conf.py --- docs/__init__.py | 0 docs/_static/.gitignore | 1 + docs/_static/graph.json | 1 - docs/conf.py | 13 +++++++++++-- docs/taskoverview.py | 9 ++++----- tox.ini | 1 - 6 files changed, 16 insertions(+), 9 deletions(-) create mode 100644 docs/__init__.py create mode 100644 docs/_static/.gitignore delete mode 100644 docs/_static/graph.json diff --git a/docs/__init__.py b/docs/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore new file mode 100644 index 0000000..4dd81db --- /dev/null +++ b/docs/_static/.gitignore @@ -0,0 +1 @@ +graph.json diff --git a/docs/_static/graph.json b/docs/_static/graph.json deleted file mode 100644 index 3485725..0000000 --- a/docs/_static/graph.json +++ /dev/null @@ -1 +0,0 @@ -{"modules": [{"name": "bootstrapvz.common.tasks.apt"}, {"name": "bootstrapvz.common.tasks.boot"}, {"name": "bootstrapvz.common.tasks.bootstrap"}, {"name": "bootstrapvz.common.tasks.cleanup"}, {"name": "bootstrapvz.common.tasks.development"}, {"name": "bootstrapvz.common.tasks.extlinux"}, {"name": "bootstrapvz.common.tasks.filesystem"}, {"name": "bootstrapvz.common.tasks.grub"}, {"name": "bootstrapvz.common.tasks.host"}, {"name": "bootstrapvz.common.tasks.initd"}, {"name": "bootstrapvz.common.tasks.kernel"}, {"name": "bootstrapvz.common.tasks.locale"}, {"name": "bootstrapvz.common.tasks.loopback"}, {"name": "bootstrapvz.common.tasks.network"}, {"name": "bootstrapvz.common.tasks.packages"}, {"name": "bootstrapvz.common.tasks.partitioning"}, {"name": "bootstrapvz.common.tasks.security"}, {"name": "bootstrapvz.common.tasks.ssh"}, {"name": "bootstrapvz.common.tasks.volume"}, {"name": "bootstrapvz.common.tasks.workspace"}, {"name": "bootstrapvz.plugins.admin_user.tasks"}, {"name": "bootstrapvz.plugins.apt_proxy.tasks"}, {"name": "bootstrapvz.plugins.chef.tasks"}, {"name": "bootstrapvz.plugins.cloud_init.tasks"}, {"name": "bootstrapvz.plugins.docker_daemon.tasks"}, {"name": "bootstrapvz.plugins.file_copy.tasks"}, {"name": "bootstrapvz.plugins.google_cloud_sdk.tasks"}, {"name": "bootstrapvz.plugins.image_commands.tasks"}, {"name": "bootstrapvz.plugins.minimize_size.tasks"}, {"name": "bootstrapvz.plugins.ntp.tasks"}, {"name": "bootstrapvz.plugins.opennebula.tasks"}, {"name": "bootstrapvz.plugins.pip_install.tasks"}, {"name": "bootstrapvz.plugins.prebootstrapped.tasks"}, {"name": "bootstrapvz.plugins.puppet.tasks"}, {"name": "bootstrapvz.plugins.root_password.tasks"}, {"name": "bootstrapvz.plugins.salt.tasks"}, {"name": "bootstrapvz.plugins.unattended_upgrades.tasks"}, {"name": "bootstrapvz.plugins.vagrant.tasks"}, {"name": "bootstrapvz.providers.azure.tasks.boot"}, {"name": "bootstrapvz.providers.azure.tasks.image"}, {"name": "bootstrapvz.providers.azure.tasks.packages"}, {"name": "bootstrapvz.providers.ec2.tasks.ami"}, {"name": "bootstrapvz.providers.ec2.tasks.boot"}, {"name": "bootstrapvz.providers.ec2.tasks.connection"}, {"name": "bootstrapvz.providers.ec2.tasks.ebs"}, {"name": "bootstrapvz.providers.ec2.tasks.filesystem"}, {"name": "bootstrapvz.providers.ec2.tasks.host"}, {"name": "bootstrapvz.providers.ec2.tasks.initd"}, {"name": "bootstrapvz.providers.ec2.tasks.network"}, {"name": "bootstrapvz.providers.ec2.tasks.packages"}, {"name": "bootstrapvz.providers.gce.tasks.apt"}, {"name": "bootstrapvz.providers.gce.tasks.boot"}, {"name": "bootstrapvz.providers.gce.tasks.configuration"}, {"name": "bootstrapvz.providers.gce.tasks.host"}, {"name": "bootstrapvz.providers.gce.tasks.image"}, {"name": "bootstrapvz.providers.gce.tasks.initd"}, {"name": "bootstrapvz.providers.gce.tasks.packages"}, {"name": "bootstrapvz.providers.kvm.tasks.packages"}, {"name": "bootstrapvz.providers.kvm.tasks.virtio"}, {"name": "bootstrapvz.providers.virtualbox.tasks.guest_additions"}, {"name": "bootstrapvz.providers.virtualbox.tasks.packages"}], "links": [{"target": 46, "definer": 15, "source": 15}, {"target": 53, "definer": 27, "source": 27}, {"target": 46, "definer": 28, "source": 28}, {"target": 41, "definer": 39, "source": 39}, {"target": 79, "definer": 41, "source": 41}, {"target": 53, "definer": 45, "source": 45}, {"target": 49, "definer": 47, "source": 47}, {"target": 49, "definer": 50, "source": 50}, {"target": 66, "definer": 51, "source": 51}, {"target": 46, "definer": 57, "source": 57}, {"target": 77, "definer": 58, "source": 58}, {"target": 66, "definer": 65, "source": 65}, {"target": 46, "definer": 67, "source": 67}, {"target": 35, "definer": 68, "source": 68}, {"target": 79, "definer": 70, "source": 70}, {"target": 49, "definer": 73, "source": 73}, {"target": 81, "definer": 78, "source": 78}, {"target": 5, "definer": 89, "source": 89}, {"target": 5, "definer": 95, "source": 95}, {"target": 49, "definer": 99, "source": 99}, {"target": 44, "definer": 100, "source": 100}, {"target": 45, "definer": 100, "source": 100}, {"target": 46, "definer": 109, "source": 109}, {"target": 4, "definer": 110, "source": 110}, {"target": 70, "definer": 112, "source": 112}, {"target": 79, "definer": 112, "source": 112}, {"target": 66, "definer": 113, "source": 113}, {"target": 77, "definer": 119, "source": 119}, {"target": 155, "definer": 120, "source": 120}, {"target": 81, "definer": 141, "source": 141}, {"target": 44, "definer": 143, "source": 143}, {"target": 45, "definer": 143, "source": 143}, {"target": 81, "definer": 150, "source": 150}, {"target": 46, "definer": 159, "source": 159}, {"target": 49, "definer": 162, "source": 162}, {"target": 53, "definer": 165, "source": 165}, {"target": 4, "definer": 167, "source": 167}, {"target": 61, "definer": 167, "source": 167}, {"target": 12, "definer": 168, "source": 168}, {"target": 44, "definer": 170, "source": 170}, {"target": 45, "definer": 170, "source": 170}, {"target": 66, "definer": 183, "source": 183}, {"target": 0, "definer": 0, "source": 1}, {"target": 1, "definer": 1, "source": 3}, {"target": 5, "definer": 5, "source": 54}, {"target": 5, "definer": 5, "source": 12}, {"target": 5, "definer": 5, "source": 11}, {"target": 6, "definer": 6, "source": 5}, {"target": 6, "definer": 6, "source": 7}, {"target": 11, "definer": 11, "source": 12}, {"target": 12, "definer": 12, "source": 9}, {"target": 16, "definer": 16, "source": 19}, {"target": 23, "definer": 23, "source": 1}, {"target": 26, "definer": 26, "source": 34}, {"target": 26, "definer": 26, "source": 24}, {"target": 27, "definer": 27, "source": 34}, {"target": 27, "definer": 27, "source": 25}, {"target": 29, "definer": 29, "source": 1}, {"target": 30, "definer": 30, "source": 38}, {"target": 31, "definer": 31, "source": 37}, {"target": 33, "definer": 33, "source": 41}, {"target": 36, "definer": 36, "source": 31}, {"target": 37, "definer": 37, "source": 32}, {"target": 38, "definer": 38, "source": 16}, {"target": 40, "definer": 40, "source": 35}, {"target": 42, "definer": 42, "source": 1}, {"target": 43, "definer": 43, "source": 34}, {"target": 44, "definer": 44, "source": 34}, {"target": 45, "definer": 45, "source": 34}, {"target": 48, "definer": 48, "source": 49}, {"target": 52, "definer": 52, "source": 66}, {"target": 64, "definer": 64, "source": 1}, {"target": 65, "definer": 65, "source": 5}, {"target": 66, "definer": 66, "source": 6}, {"target": 68, "definer": 68, "source": 69}, {"target": 70, "definer": 70, "source": 41}, {"target": 72, "definer": 72, "source": 1}, {"target": 82, "definer": 82, "source": 1}, {"target": 83, "definer": 83, "source": 49}, {"target": 90, "definer": 90, "source": 1}, {"target": 93, "definer": 93, "source": 1}, {"target": 93, "definer": 93, "source": 0}, {"target": 95, "definer": 95, "source": 54}, {"target": 100, "definer": 100, "source": 43}, {"target": 100, "definer": 100, "source": 170}, {"target": 101, "definer": 101, "source": 97}, {"target": 102, "definer": 102, "source": 103}, {"target": 108, "definer": 108, "source": 16}, {"target": 111, "definer": 111, "source": 79}, {"target": 112, "definer": 112, "source": 41}, {"target": 115, "definer": 115, "source": 1}, {"target": 115, "definer": 115, "source": 0}, {"target": 116, "definer": 116, "source": 1}, {"target": 118, "definer": 118, "source": 66}, {"target": 118, "definer": 118, "source": 185}, {"target": 121, "definer": 121, "source": 66}, {"target": 121, "definer": 121, "source": 185}, {"target": 122, "definer": 122, "source": 1}, {"target": 123, "definer": 123, "source": 126}, {"target": 129, "definer": 129, "source": 66}, {"target": 130, "definer": 130, "source": 1}, {"target": 132, "definer": 132, "source": 1}, {"target": 134, "definer": 134, "source": 138}, {"target": 135, "definer": 135, "source": 1}, {"target": 137, "definer": 137, "source": 80}, {"target": 137, "definer": 137, "source": 136}, {"target": 145, "definer": 145, "source": 1}, {"target": 146, "definer": 146, "source": 66}, {"target": 147, "definer": 147, "source": 153}, {"target": 149, "definer": 149, "source": 157}, {"target": 149, "definer": 149, "source": 151}, {"target": 151, "definer": 151, "source": 148}, {"target": 153, "definer": 153, "source": 154}, {"target": 153, "definer": 153, "source": 160}, {"target": 153, "definer": 153, "source": 161}, {"target": 155, "definer": 155, "source": 156}, {"target": 163, "definer": 163, "source": 1}, {"target": 166, "definer": 166, "source": 1}, {"target": 168, "definer": 168, "source": 9}, {"target": 169, "definer": 169, "source": 3}, {"target": 169, "definer": 169, "source": 0}, {"target": 172, "definer": 172, "source": 60}, {"target": 174, "definer": 174, "source": 59}, {"target": 175, "definer": 175, "source": 176}, {"target": 176, "definer": 176, "source": 174}, {"target": 177, "definer": 177, "source": 47}, {"target": 177, "definer": 177, "source": 48}, {"target": 178, "definer": 178, "source": 1}, {"target": 179, "definer": 179, "source": 178}, {"target": 180, "definer": 180, "source": 1}, {"target": 180, "definer": 180, "source": 0}, {"target": 180, "definer": 180, "source": 178}, {"target": 181, "definer": 181, "source": 1}, {"target": 185, "definer": 185, "source": 66}, {"target": 186, "definer": 186, "source": 1}], "nodes": [{"name": "AddBackports", "module": 0, "phase": 0}, {"name": "AddDefaultSources", "module": 0, "phase": 0}, {"name": "AddManifestPreferences", "module": 0, "phase": 0}, {"name": "AddManifestSources", "module": 0, "phase": 0}, {"name": "AptClean", "module": 0, "phase": 7}, {"name": "AptUpdate", "module": 0, "phase": 5}, {"name": "AptUpgrade", "module": 0, "phase": 5}, {"name": "DisableDaemonAutostart", "module": 0, "phase": 5}, {"name": "EnableDaemonAutostart", "module": 0, "phase": 7}, {"name": "InstallTrustedKeys", "module": 0, "phase": 5}, {"name": "PurgeUnusedPackages", "module": 0, "phase": 7}, {"name": "WritePreferences", "module": 0, "phase": 5}, {"name": "WriteSources", "module": 0, "phase": 5}, {"name": "BlackListModules", "module": 1, "phase": 6}, {"name": "DisableGetTTYs", "module": 1, "phase": 6}, {"name": "AddRequiredCommands", "module": 2, "phase": 0}, {"name": "Bootstrap", "module": 2, "phase": 4}, {"name": "ExcludePackagesInBootstrap", "module": 2, "phase": 0}, {"name": "IncludePackagesInBootstrap", "module": 2, "phase": 0}, {"name": "MakeTarball", "module": 2, "phase": 4}, {"name": "CleanTMP", "module": 3, "phase": 7}, {"name": "ClearMOTD", "module": 3, "phase": 7}, {"name": "TriggerRollback", "module": 4, "phase": 10}, {"name": "AddExtlinuxPackage", "module": 5, "phase": 0}, {"name": "ConfigureExtlinux", "module": 5, "phase": 6}, {"name": "ConfigureExtlinuxJessie", "module": 5, "phase": 6}, {"name": "InstallExtlinux", "module": 5, "phase": 6}, {"name": "InstallExtlinuxJessie", "module": 5, "phase": 6}, {"name": "AddRequiredCommands", "module": 6, "phase": 0}, {"name": "AddXFSProgs", "module": 6, "phase": 0}, {"name": "CopyMountTable", "module": 6, "phase": 4}, {"name": "CreateBootMountDir", "module": 6, "phase": 3}, {"name": "CreateMountDir", "module": 6, "phase": 3}, {"name": "DeleteMountDir", "module": 6, "phase": 8}, {"name": "FStab", "module": 6, "phase": 6}, {"name": "Format", "module": 6, "phase": 2}, {"name": "MountBoot", "module": 6, "phase": 3}, {"name": "MountRoot", "module": 6, "phase": 3}, {"name": "MountSpecials", "module": 6, "phase": 4}, {"name": "RemoveMountTable", "module": 6, "phase": 8}, {"name": "TuneVolumeFS", "module": 6, "phase": 2}, {"name": "UnmountRoot", "module": 6, "phase": 8}, {"name": "AddGrubPackage", "module": 7, "phase": 0}, {"name": "ConfigureGrub", "module": 7, "phase": 6}, {"name": "InstallGrub_1_99", "module": 7, "phase": 6}, {"name": "InstallGrub_2", "module": 7, "phase": 6}, {"name": "CheckExternalCommands", "module": 8, "phase": 0}, {"name": "AddExpandRoot", "module": 9, "phase": 6}, {"name": "AdjustExpandRootScript", "module": 9, "phase": 6}, {"name": "InstallInitScripts", "module": 9, "phase": 6}, {"name": "RemoveHWClock", "module": 9, "phase": 6}, {"name": "AddDKMSPackages", "module": 10, "phase": 5}, {"name": "DetermineKernelVersion", "module": 10, "phase": 5}, {"name": "UpdateInitramfs", "module": 10, "phase": 6}, {"name": "GenerateLocale", "module": 11, "phase": 5}, {"name": "LocaleBootstrapPackage", "module": 11, "phase": 0}, {"name": "SetTimezone", "module": 11, "phase": 6}, {"name": "AddRequiredCommands", "module": 12, "phase": 0}, {"name": "Create", "module": 12, "phase": 1}, {"name": "MoveImage", "module": 12, "phase": 9}, {"name": "ConfigureNetworkIF", "module": 13, "phase": 6}, {"name": "RemoveDNSInfo", "module": 13, "phase": 7}, {"name": "RemoveHostname", "module": 13, "phase": 7}, {"name": "SetHostname", "module": 13, "phase": 6}, {"name": "AddManifestPackages", "module": 14, "phase": 0}, {"name": "AddTaskselStandardPackages", "module": 14, "phase": 5}, {"name": "InstallPackages", "module": 14, "phase": 5}, {"name": "AddRequiredCommands", "module": 15, "phase": 0}, {"name": "MapPartitions", "module": 15, "phase": 2}, {"name": "PartitionVolume", "module": 15, "phase": 2}, {"name": "UnmapPartitions", "module": 15, "phase": 8}, {"name": "EnableShadowConfig", "module": 16, "phase": 6}, {"name": "AddOpenSSHPackage", "module": 17, "phase": 0}, {"name": "AddSSHKeyGeneration", "module": 17, "phase": 6}, {"name": "DisableSSHDNSLookup", "module": 17, "phase": 6}, {"name": "DisableSSHPasswordAuthentication", "module": 17, "phase": 6}, {"name": "ShredHostkeys", "module": 17, "phase": 7}, {"name": "Attach", "module": 18, "phase": 1}, {"name": "Delete", "module": 18, "phase": 10}, {"name": "Detach", "module": 18, "phase": 8}, {"name": "CreateWorkspace", "module": 19, "phase": 0}, {"name": "DeleteWorkspace", "module": 19, "phase": 10}, {"name": "AddSudoPackage", "module": 20, "phase": 0}, {"name": "AdminUserCredentials", "module": 20, "phase": 6}, {"name": "CreateAdminUser", "module": 20, "phase": 6}, {"name": "DisableRootLogin", "module": 20, "phase": 6}, {"name": "PasswordlessSudo", "module": 20, "phase": 6}, {"name": "CheckAptProxy", "module": 21, "phase": 0}, {"name": "RemoveAptProxy", "module": 21, "phase": 7}, {"name": "SetAptProxy", "module": 21, "phase": 5}, {"name": "AddPackages", "module": 22, "phase": 0}, {"name": "CheckAssetsPath", "module": 22, "phase": 0}, {"name": "CopyChefAssets", "module": 22, "phase": 6}, {"name": "AddCloudInitPackages", "module": 23, "phase": 0}, {"name": "DisableModules", "module": 23, "phase": 6}, {"name": "SetMetadataSource", "module": 23, "phase": 5}, {"name": "SetUsername", "module": 23, "phase": 6}, {"name": "AddDockerBinary", "module": 24, "phase": 6}, {"name": "AddDockerDeps", "module": 24, "phase": 5}, {"name": "AddDockerInit", "module": 24, "phase": 6}, {"name": "EnableMemoryCgroup", "module": 24, "phase": 6}, {"name": "PullDockerImages", "module": 24, "phase": 6}, {"name": "FileCopyCommand", "module": 25, "phase": 6}, {"name": "MkdirCommand", "module": 25, "phase": 6}, {"name": "ValidateSourcePaths", "module": 25, "phase": 0}, {"name": "InstallCloudSDK", "module": 26, "phase": 6}, {"name": "RemoveCloudSDKTarball", "module": 26, "phase": 7}, {"name": "ImageExecuteCommand", "module": 27, "phase": 6}, {"name": "AddFolderMounts", "module": 28, "phase": 4}, {"name": "AddRequiredCommands", "module": 28, "phase": 0}, {"name": "RemoveFolderMounts", "module": 28, "phase": 7}, {"name": "ShrinkVolume", "module": 28, "phase": 8}, {"name": "Zerofree", "module": 28, "phase": 8}, {"name": "AddNtpPackage", "module": 29, "phase": 5}, {"name": "SetNtpServers", "module": 29, "phase": 6}, {"name": "AddONEContextPackage", "module": 30, "phase": 0}, {"name": "AddPipPackage", "module": 31, "phase": 0}, {"name": "PipInstallCommand", "module": 31, "phase": 6}, {"name": "CopyImage", "module": 32, "phase": 5}, {"name": "CreateFromImage", "module": 32, "phase": 1}, {"name": "CreateFromSnapshot", "module": 32, "phase": 1}, {"name": "Snapshot", "module": 32, "phase": 5}, {"name": "AddPackages", "module": 33, "phase": 0}, {"name": "ApplyPuppetManifest", "module": 33, "phase": 6}, {"name": "CheckAssetsPath", "module": 33, "phase": 0}, {"name": "CheckManifestPath", "module": 33, "phase": 0}, {"name": "CopyPuppetAssets", "module": 33, "phase": 6}, {"name": "EnableAgent", "module": 33, "phase": 6}, {"name": "SetRootPassword", "module": 34, "phase": 6}, {"name": "BootstrapSaltMinion", "module": 35, "phase": 5}, {"name": "InstallSaltDependencies", "module": 35, "phase": 0}, {"name": "SetSaltGrains", "module": 35, "phase": 6}, {"name": "AddUnattendedUpgradesPackage", "module": 36, "phase": 0}, {"name": "EnablePeriodicUpgrades", "module": 36, "phase": 6}, {"name": "AddInsecurePublicKey", "module": 37, "phase": 6}, {"name": "AddPackages", "module": 37, "phase": 0}, {"name": "CheckBoxPath", "module": 37, "phase": 0}, {"name": "CreateVagrantBoxDir", "module": 37, "phase": 0}, {"name": "CreateVagrantUser", "module": 37, "phase": 6}, {"name": "PackageBox", "module": 37, "phase": 9}, {"name": "PasswordlessSudo", "module": 37, "phase": 6}, {"name": "RemoveVagrantBoxDir", "module": 37, "phase": 10}, {"name": "SetRootPassword", "module": 37, "phase": 6}, {"name": "ConfigureGrub", "module": 38, "phase": 6}, {"name": "ConvertToVhd", "module": 39, "phase": 9}, {"name": "DefaultPackages", "module": 40, "phase": 0}, {"name": "Waagent", "module": 40, "phase": 5}, {"name": "AMIName", "module": 41, "phase": 0}, {"name": "BundleImage", "module": 41, "phase": 9}, {"name": "RegisterAMI", "module": 41, "phase": 9}, {"name": "RemoveBundle", "module": 41, "phase": 10}, {"name": "UploadImage", "module": 41, "phase": 9}, {"name": "ConfigurePVGrub", "module": 42, "phase": 6}, {"name": "Connect", "module": 43, "phase": 0}, {"name": "GetCredentials", "module": 43, "phase": 0}, {"name": "Attach", "module": 44, "phase": 1}, {"name": "Create", "module": 44, "phase": 1}, {"name": "Snapshot", "module": 44, "phase": 9}, {"name": "S3FStab", "module": 45, "phase": 6}, {"name": "AddExternalCommands", "module": 46, "phase": 0}, {"name": "GetInstanceMetadata", "module": 46, "phase": 0}, {"name": "SetRegion", "module": 46, "phase": 0}, {"name": "AddEC2InitScripts", "module": 47, "phase": 6}, {"name": "AddBuildEssentialPackage", "module": 48, "phase": 0}, {"name": "EnableDHCPCDDNS", "module": 48, "phase": 6}, {"name": "InstallEnhancedNetworking", "module": 48, "phase": 6}, {"name": "DefaultPackages", "module": 49, "phase": 0}, {"name": "CleanGoogleRepositoriesAndKeys", "module": 50, "phase": 7}, {"name": "ImportGoogleKey", "module": 50, "phase": 5}, {"name": "SetPackageRepositories", "module": 50, "phase": 0}, {"name": "ConfigureGrub", "module": 51, "phase": 6}, {"name": "GatherReleaseInformation", "module": 52, "phase": 6}, {"name": "DisableIPv6", "module": 53, "phase": 6}, {"name": "InstallHostnameHook", "module": 53, "phase": 6}, {"name": "CreateTarball", "module": 54, "phase": 9}, {"name": "RegisterImage", "module": 54, "phase": 9}, {"name": "UploadImage", "module": 54, "phase": 9}, {"name": "AdjustExpandRootDev", "module": 55, "phase": 6}, {"name": "DefaultPackages", "module": 56, "phase": 0}, {"name": "GooglePackages", "module": 56, "phase": 0}, {"name": "ReleasePackages", "module": 56, "phase": 0}, {"name": "DefaultPackages", "module": 57, "phase": 0}, {"name": "VirtIO", "module": 58, "phase": 6}, {"name": "AddGuestAdditionsPackages", "module": 59, "phase": 5}, {"name": "CheckGuestAdditionsPath", "module": 59, "phase": 0}, {"name": "InstallGuestAdditions", "module": 59, "phase": 5}, {"name": "DefaultPackages", "module": 60, "phase": 0}], "phases": [{"name": "Preparation", "description": "Initializing connections, fetching data etc."}, {"name": "Volume creation", "description": "Creating the volume to bootstrap onto"}, {"name": "Volume preparation", "description": "Formatting the bootstrap volume"}, {"name": "Volume mounting", "description": "Mounting bootstrap volume"}, {"name": "OS installation", "description": "Installing the operating system"}, {"name": "Package installation", "description": "Installing software"}, {"name": "System modification", "description": "Modifying configuration files, adding resources, etc."}, {"name": "System cleaning", "description": "Removing sensitive data, temporary files and other leftovers"}, {"name": "Volume unmounting", "description": "Unmounting the bootstrap volume"}, {"name": "Image registration", "description": "Uploading/Registering with the provider"}, {"name": "Cleaning", "description": "Removing temporary files"}]} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 5abdcfc..5e1d3e4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,8 +14,6 @@ import sys import os -import glob -import os.path # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -267,6 +265,9 @@ texinfo_documents = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation', # -- Link to rst files scattered throughout the project ------------------- +import glob +import os.path + for readme_path in glob.glob('../bootstrapvz/providers/*/README.rst'): provider_name = os.path.basename(os.path.dirname(readme_path)) include_path = os.path.join('providers', provider_name + '.rst') @@ -281,3 +282,11 @@ for readme_path in glob.glob('../bootstrapvz/plugins/*/README.rst'): path_to_readme = os.path.join('../../bootstrapvz/plugins', plugin_name, 'README.rst') with open(include_path, 'w') as include: include.write('.. include:: ' + path_to_readme) + + +# -- Create task overview graph data -------------------------------------- + +from docs import taskoverview + +data = taskoverview.generate_graph_data() +taskoverview.write_data(data, '_static/graph.json') diff --git a/docs/taskoverview.py b/docs/taskoverview.py index c1b142f..97ecbb0 100755 --- a/docs/taskoverview.py +++ b/docs/taskoverview.py @@ -5,7 +5,7 @@ import os.path sys.path.append(os.path.join(os.path.dirname(__file__), '..')) -def main(opts): +def generate_graph_data(): from bootstrapvz.base.tasklist import get_all_tasks tasks = get_all_tasks() @@ -49,13 +49,11 @@ def main(opts): link[key] = tasks.index(link[key]) return link - data = {'phases': map(mk_phase, phases.order), + return {'phases': map(mk_phase, phases.order), 'modules': map(mk_module, modules), 'nodes': map(mk_node, tasks), 'links': map(mk_link, task_links)} - write_data(data, opts.get('--output', None)) - def write_data(data, output_path=None): import json @@ -77,4 +75,5 @@ if __name__ == '__main__' and __package__ is None: """ opts = docopt(usage) - main(opts) + data = generate_graph_data() + write_data(data, opts.get('--output', None)) diff --git a/tox.ini b/tox.ini index 0ec323d..e538b91 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,6 @@ changedir = docs deps = sphinx commands = - ./taskoverview.py --output _static/graph.json sphinx-build -W -b html -d _build/html/doctrees . _build/html [testenv:docs-serve]