diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-09 17:14:10 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-09 17:14:10 -0400 |
| commit | 055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd (patch) | |
| tree | 88027f4c462d5246f277d569ab173ce9488b035b /buildstream/plugins/sources/tar.py | |
| parent | 71b78794527bd231962736a5a207973fd02ad09d (diff) | |
| download | buildstream-055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd.tar.gz | |
doc: Added plugins as ToC elements instead of orphaned links
o Now the page titles are declared in plugins, allowing for
a more descriptive ToC
o Makefile and plugin.rsttemplate updated to not produce the title,
to no longer use `:orphan:` for plugin pages, and to ignore any
private modules in the plugin directories.
o Interestingly, now the docs will fail to build if you add
a new plugin and forget to add it to the documentation.
Diffstat (limited to 'buildstream/plugins/sources/tar.py')
| -rw-r--r-- | buildstream/plugins/sources/tar.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/buildstream/plugins/sources/tar.py b/buildstream/plugins/sources/tar.py index e41824505..324006b21 100644 --- a/buildstream/plugins/sources/tar.py +++ b/buildstream/plugins/sources/tar.py @@ -1,4 +1,5 @@ #!/usr/bin/env python3 +# # Copyright (C) 2017 Codethink Limited # # This program is free software; you can redistribute it and/or @@ -17,7 +18,9 @@ # Authors: # Jonathan Maw <jonathan.maw@codethink.co.uk> -"""A source implementation for staging tar files +""" +tar - stage files from tar archives +=================================== **Usage:** |