docs: Add docstring to oneshot method

This commit is contained in:
Cristian 2020-07-31 10:28:30 -05:00
parent e6c571beb2
commit a8c74730f8

View file

@ -496,6 +496,10 @@ def status(out_dir: str=OUTPUT_DIR) -> None:
@enforce_types @enforce_types
def oneshot(url: str, out_dir: str=OUTPUT_DIR): def oneshot(url: str, out_dir: str=OUTPUT_DIR):
"""
Create a single URL archive folder with an index.json and index.html, and all the archive method outputs.
You can run this to archive single pages without needing to create a whole collection with archivebox init.
"""
oneshot_link, _ = parse_links_memory([url]) oneshot_link, _ = parse_links_memory([url])
if len(oneshot_link) > 1: if len(oneshot_link) > 1:
stderr( stderr(